diff --git a/docs/assets/hierarchy.js b/docs/assets/hierarchy.js index d14e0a3a..a2f22e89 100644 --- a/docs/assets/hierarchy.js +++ b/docs/assets/hierarchy.js @@ -1 +1 @@ -window.hierarchyData = "eJy1XF1v27gS/S9+ZnfFT5F5S9J2N0CzLeLuFotFUKgW4+hWplxJ7m3uov/9gpTskopkk5T7YicGZ87hkBxyZij9u6irqm0WF/8IJCCAAELKAYRpCiBOOAeQJDwBkECSAIgRJUBAJoCAlAFI04QCjFiq/4QQQIxTAjhlAkBKIQWQMkEBJAilgFORAJ4gASCCFAGIEsgNilbMtHpMGOAUmx8QBRAKRgFmAnCaMKMMgVQwDCDmGBsN+leq4ZimTAmnRg8HkMEUmk8GOEwSIJLUiBhxnIp7sKjlQylXbVGpZnHx7wLqD5Vt5OJicbktLrfbBVh8LlS+uICIg8WuLhcXi1WZNY1sfu1a/PLYbsoF6H5dXCzaJn+hRV50P4DF6rEo81qqxcU/mN9/BwvMXZg32eZTnp0GO7Q7AakhmLAwbi537ePromxlfYBAlO0hCtXK+iFbyeZXq+UkyKH5sG9p17nUQr7KmmI1gj7SwUHT030kSeLYcXtdqYdifdyIfaPT2vUycIfpqsqfjin/aAyjsvLjL33rkKkBIWMAMkTvDThjLvi7rM42/uimuU8n09TFebuVdabXgz/WQSSouymCpqcosRfd2223Fo/PUgu/FwidrCRJDDpO8DP0rPxNtpFEbFkPTh0Fe57FQAdBuqOAE+0LIe6MAbHL5LIsY8j8EPM0AUP0+VK7UQ9V2HLTEh5zPkVwYs6HQTpiHrgc2z75Ms+fr7WT1rWlPI3LCbFg7+Sm+iojkAeC3uCpA74ts1UcuivpC0+RBX8b1/PbmH5T239fV9unCGBHzBeY2Zvie9m0EcCOmDcwHbqxYFxbyhc2tRfzVaHyG/XhUaq36nW5k6pdPqk2++ZPYUqDJx3h7Nta2VwyUVRcJ89Ts9Ui6syNO5nl2adSejq8ffOQTZ5imgKYkG5/wQjbY7XEv7ftVh/4lqtHuZHv6uprkZ88oVqUpjT4jRVG2HaMl/9trmuZS9UWWXljvtunAMc8Jh46Upwy1FmKDQ7RMX7LEQufNFgAvXfojxRoT6o/GNAeRn/Qnqh4tvzmLLxzzHOMRDogNWcBzlx8gjFDCnMy4hnm+YWzEGPcPn8uV1mZ1e+zdcAy3It4rrsUEWdvLPsIPAjUEfME5sTuqes7btR21w4CyJMkJlX4EuL2gftyLVXre/zUbUNcMUmYCc/19xzMF9AjMEcYDTGC4whb6gioY1CCEzEY4Tv5ZSebNmxMe6HgJYUSRIyRsbB5/Hn3xh//z7s3np0l0B7JZVtL7wxB1zhk/ujDAyCcQKA3ddNJ6vj+AT7Zo2+qfFcGoWuFzXbfyxQ/72XwZOoRHenglEFKBSCpMIkD/c/IWSqW2EDei9pOFV928o9sI99ltVQmhavH5N49giFBO8LCPvx9qIt2DuGBfKgtD6w4gSOswmbxXir8ZEqoMAlZTcei8XK3LeW3WNM40qGGYRALwwjT9BmjMLN0MiFGYQhCIEh3itJM7EiyzlTzUNXRa2+owM/JaUpjLMJMcRALsoYQ5oCkvy0K77Kmef9YV7v1YxgJS/D0Fpqm3O7360IVzaPMY40/kD+jf4EMMzNjU07GosvBtuCR6LHlQpeP2aV0cclsw7pQZFdBWlk73uUkmb1E+EEAJiaQ08Uui8Grr1K1rzZFe7oQY7GwpUKZ6FEBXFfABOzWta6EORtq1hYrGyJijk2oCA5/IUo6iug4RTMubXUOqgNVfl5JG3Rk2wqd665c8HlEH8YOc52ThDrJlVffWqmaolJdRLILzR5MafC0EHEs9LpQWVn8T/6eqbyU9WW93m2MS/GmM6XBlw5Ppum83bXbXUCIMCruSYQmtl3C80yxqSWd7TLzhELmzJNBCk3XDWUr65BFNanD1yZ4Oi4PzwpG5wSH9urcJXUy+X1kuCzWqlDriHk8ocDXUgwNFvm2lk0TPo2eiXoTcPJ91U7lS1l/LVYyOIf1TDZ8iJgAOtkHdHKtGywnyHlZrYx1Pc9p++Yhh0TOukCGM0GOIR8Lh0/iOgGxRnSOo3Ujc3+zH8A6weiToO6w6ThHc+h4szBQjM2G8k0lcS74fDDkCSaceRsJhv3A9C0oO6TK1rpQEFAc7ASCVyvjHOjc773h4NwS6jLIvuGUaRy0SHmX6tZX1tyKzzL/vCzWfxG9X0RlgKd1hF+fIrwj6bhYG+AsLM9G0ym8jkY2x8fRK6wZvUPHMdDJTyBwP5uQs3xGuRxzwF5MHCesr0rag/Spqtuw0NLBPMhHu2NtgvtBuhKnQKcRegvhCQvdyQdZS7XSp5HmSa3uZFPt6lVsV3xUe/opDKdiZ0dbcBA4yXdMrS9Xp6Y1qTRmaUwqO51F0rk8281Wq8/S9zTUNfa41qTL+3ZIo1bVplDrW9k02dq3xwMpn5uLCXau2JSFVO2w2nMc1JHxgeSpffy+rpTqSpDBU/CZaHDwjzDqLooK596NDn6GlveKmE4Z/ljJC+i6m77vTfacuLPP5rmZw2+KppUqIsE0ocDzSo6+ZD5cm9FUInkMbvoKzvq7r47bGKtXHp/BPsXKH/MXJc5tvE642Vaq8V2mtogXoJOAteugx3GOFUHHittYiM6gMEEu4FJm9erRpCQaf3Bbyqef0LlnOCubeoY8qt45e3NQ9+5nluucY1RS3hIMrvb1FWOIE+cGmtnN9jn2fSI2wC2MiftfuuajTCIZ+CEP716z/hI6dDyUWwK5+vvtlf4lJAU2pcHXOBBP83kpH7Jd2c6j5CjxZYXQcKfrE7BzU90nVQUXMkjSPcaBkVNE7bs9l+9RNTO40sF9yDu5Lio1l+0JRTP4Os5kn/Y9x2SY1hPPFru3dWRdzKyITKoI55iynqPzZMSNKtpiTp1kQkE4P977SUzs48THcxQvjigJv70L93YkbGRmxpM8F0NjwT1F59ZndD0jopAxMBrdG43ag3u7K9tiW0od7JZfZf5XVu7krWyzPGuzG/UfuQq/Uuiv03dLwo4L2uvfPwr2M7j76/bvgz0Tfgb3n8A5dS5TZ81Z54mfvojFR82Dx92Dzoz30z61Twh/X96+eVXXlW8S9dA+6NlLTJIenTgPH2ptH7JaL+gA/F7CI07CBCcDuNvs6FPPA6jbLOhxa13E6fpJnWSRVrWUXwKAl/JLELAQ/ZbF3KvQZZH5hqGmbVhv+4eH9aPxFugfVS6dEs9x3H3zEGhdzwGmswBiQfpoTzjphh839n3TcweBwMmN9QKjuNtX9NsLhpFeYDo2JOvqmgWJbrvVL0+YIhGeDotLU4+nCIhbE9vnYU1IZKKzAGIjwp4OXb8ewo6TilXAMVO3DnbGxLy+glDYLRn9h70L7tp1FWuGEWFfM1Cn6LxXFJZKH0iFvYMg6VeNfo2GE66sdrW8rlQrv4Xvp2PS4UlTnnbZZeoO1XW12ZggLT4XP6pgDkGCBsf/Z2lWz8dQTmRap5PyvQvWb0aZzOT8pnPYxWpeJsdREn4kguYFMLB7L4p5hYtDt62flm2dtXL9FBnOT+sIJ4u6u/nmLTTH4uSIMGpaR8QxE+4H332qQTaDjEFoPD+lIYJi//IP/fqgwUH+ZwR+YXpnHOz7TjnPLHSP4Z4/qgrTG9EpJ06h3Lk2PtwUT5SNTuyCPyIEyqmz72zljALBmLTvG0nc6y22pjj8YPtrg9/3VNgYlThTxBQq9KB0VNzXSs19KkVVufzYmL8/butqUzSyiXhU5fv37/8HV2iw8A==" \ No newline at end of file +window.hierarchyData = "eJy1XO9v2zYT/l/8md3EH5LIfEvTdgvQrEXcrhiGolAlxtFbWXIluWs29H9/cZTsiLJk8+j0SxIEvHseHskj747Uf4u6qtpmcfG3YgEjlFAqGKE0ooQyIWNCOQ9C+ClCQlkUcqICGRAVRDGhgquYcB5QQoUIOKEslhGRQgaECqookZxxaGYUCR4SGQaUyACgGGOKUBYoUCwjox3+EYeSSCHgz4gJInnICY8UkYIaSClIrHhEKKchJ5TGilCqQIvgDJhwrgBeBKAsAiqKU/MzIjKIOZFKCkKFDAWhrG+n6EeyqPVdodM2r8pmcfHfgsKPMlnrxcXicpNfbjYLsviSl9nigjJJFtu6WFws0iJpGt382rX45b5dFwvS/XdxsWib7BmIPOv+QRbpfV5ktS4XF39z+fEHWXBpw7xO1p+z5DTYvt0JSICI1ADj+nLb3r/Ki1bXewgWRjuIvGx1fZekuvl10HIWZN983Le461w8QH6eNHk6gT7RwVHT030UQWDZcXNVlXf56rgR+0antcOysIfpeZU9HFP+yRimTIpPv/StMVOD0jAgNAr4RwMe2n3L3yZ1snZHN81dOhmNpvybja4TWA/uWHsRVHcjpbqexsOZ+mbTrcXjs3SA3wtgJ6sIAoPOJD1AT4rfdOtJZCjrwKmjEA0o+ECjIO1RYBLcvqKdMRS1mVwWhQ+ZRzFHE0QBP1xq1+VdhVtuIOEw5yOlZuY8DtISc8CV1MLNssO1dtK6QylH40omBrC3el190x7II0Fn8NgC3xRJ6oduS7rC86EPv/Hr+Y1Pv/lwUV9VmwcPYEvMFVgMN453umk9gC0xZ+Bw7MbQuEMpV9hw6LOe52V2XX641+Wb8lWx1WW7fCjb5Ls7hTkNjnSUiEZ0ziXjRcV28jI0/p2FglqLMcmSz4V2dHi75phNPuSMERpwxczJkPKhM7gqcl22b+uqrdKqQKwKS85tXDiNhzvM7227udVft7pp3XEHQvhtlga0M4EMD3g0m6psNJZIJ+XBhAnDhEVDJksOWuH0vUzv9Vq/ratveXYyXBiwmtPgOEAssoKif5qrWme6bPOkuDa/2wfELjkljjWVFLE5i0O0a0c0PpuIJYZfwVQR2MjhR0xgW4MfEQF3Dz/Cnig/8IXneMGncDqcW6ceUHyONzzTEyoRdaR4MOGmz3PST0Is4sMhXKZJkdTvkhViGe5EHNddZCUKrqqiT4egQC0xR+BYiZEnfPQd1+Vm246ieSe3OKnCkZC05sTlSpetaywAbTH7ogioSQTB73Mwn1GHLAmVfIyBDuqGUkdALYMKLobA729fu+O9v33tCmIlMJZtrZ3TJF1jzLjBCYqIWEkCJxszgiHl8/hih76usm2BQgeFzWbXy0iKAxT0IPaIljQ6bxIHkohYdJ2PAzlxoPQlNpJ3orYt869b/Uey1m+TWpcmrw1j8tE+h7JQdIStnN6HOm/PITySx9rykZWSE6xws3gnhT+e85AZZwR0BjRebDeF/u5rGksaa5iIBsYwwO+AEc4snQzGKBGVgigRmvwgMBmG03VSNndV7b32xgrcnBxQmmKBM8VeDGUNFZk0LfweUHibNM27+7raru5xJAaCp7euOLZm5Ku8zJt7nfkafyT/hP6FhjQ257dYWtvBzqONtgWHbNdQDrt8zC5FGePmAA6Vs2EpqNW15V1OktlJeISasZk7UPwbMHj5TZfty3Xenq5GDVgMpbBMYFSIpDyCSibrKMX2tp20eTqE8JhjMyrQYWegeEdRHadoxqWtnoLqSJWbVwKDTmxb2Lluy+HPI0o+znXJYuucxF9+b3XZ5FXZRQJbbNQ+p8HRQpxxK7jqNUBvdZ3pq6ps9XdECmpOA7pUS3kMlfoYKu5QumdRVwKC/1mMM51i6GU6dTVNOE7I3eimSVbIPFgv5JWQI5AVJJCS67oupb3ZJEX+r/49KbNC15f1ars2/t+Z3pwGVwMpNk/nzbbdbBETZ1LckYigwymBT8b55t8gJWgGRlhz8iDPCJVu3eoa4wFndbjaRKjZ5AU+deqdOB3bq5vIIrJrbiZlvcxXZV6uPObxjAJXS9kbLX/5fVPrpsFPowNRVwLSSvVV2zJb6vpbnmp0ou9AFj1EPOAEMqIEMpBmsEIrufyiSo11HQ/Vu+aYE72MAnNUlVEQHkM+lrs4iWtlLwDRih3qRmfuZt+DdYLex3bosOl4zM+h48zCQMXx2VCu+TYpA3U+GHMEU9a89QTjrmB2/JusoJqCKGd3AujVGnG4h9gFwFJZSZouze4a+5rGqEUax+YyHVy6tMtiy+zLMl/9KWC/8EqTz+tA2ydWoiNpudghwJOwfDqaJ8PQ4+PoFINO3vrkAYFMNVGMGx+kmLV8Jrkcc8BOTCwnDJd9h4P0uapbXB7AwtzLe7tjMIGdRYEsN4GcT28hMWOhW32na12mcBppHsr0VjfVtk59u+Ki2s1PKWaVkIaKLW3oiH2W75RaZ66hC1efpTGr7HTKDxKvQzdbpV+062moa+xwES+wY6vrMq3WebkaB6DH0UZSLndtAzo0eXePZXwN5TioJeMCKe1tuq6+P7wsvyE26l7C8foTlRE7jD3Q892Wc8VWfJRtKbuaNBr+QBSdlaKyv8at1HDI32pdX+m6ze/yNGkRDmskiE53CBr3952DyKoGZ5lZrK/zptWlR9pzRoHr1edAHTghbyqePEZ5oSDqRg4SRCdujB1fqi7XxR4XKlzLOnUxzAXvxK2wIaB1UXRYnT+Oc6w0P3XVgYudQa2L/u9vXy91Uqf3JvfSuIMPpVz6yZia2efO2oY9JxgcETpzMD6+jAmZcK9S0UAQXYPu7zFQJkLrdjps27vKz648gHALU+KuTkFYL4geVXkycEMeuQERdq9TWEjj0TA9Fiue//XmOfwHk+ub0+BqnJDP83mh75Jt0Z5HyVLiyio68F59pvncAsxJVejyGotFN7KR9Qyv7/a5fI+qOYOrVS25/Ke51au8Ks9le0LROXyn8uNPMRnm9ZzB1spfLO+TDVTXclMxwdyAtgWd14716sooeaEbX/yhqCuD2Noi9z3wL33NqkCPEZeyG6PYOtxfl3mbn1MQm1GA56f67TMOhyfZT09RpTqiBH+XncU7nnJiZfqTfCqGxoI9xchajt6FK4+K1cho0c5o1luJm23R5ptCQ1aj+KazP5Niq290m2RJm1yX/9MpPuJ11+m8qGM2wXn3SvVncHfX7dwHyzH/DO4/g7P1AixpnnSeuOnzWHwRfJMhjpn5okMfosTWzvTX5c3rl3VduWbL9+1Rz8KZZLuX2SwYoX9IaljQCPxewiVOlNbVYBC+SY5+kGEEdZOgvgQB1br+0bWQI+Cl/ooAXuqvKGDVPUWjPBDDQ/tlkSeuYbhpi6tn8agDpdZJ9o8q01Yt7zjurjmuv3BDDDpLKGe08+jwx+SzF9c87F4AObnhUysw4h0LbpXgffLumPT6KBHR3bE233mZI4FPB/rVI6ZTJJxHwjrzdQl3ExKa6BRBbELY0aHDR2yGcWKeIo6Z0BrtjKHf8PEc+P6OCGS/cIQ1TG+27aryNcaEsKsxQiYnWOAqJyMp3EdSAtqdEsEwdmUj1U2DrW30MughgrpKR8NOoy51uq13tzLxF3MnpD2oRfA5J8V5TzAOrDRHm+SFzrwrETMKHOcPfCLK8rvrtYni/Ss1kwrwRtubi7OpN/Jdauw3qCzk6Xn5NUsJ/qAWwiexIAvY0+XKotvWD8u2Tlq9evBMsszrwJONuu9dmU94HYvePYK7eR0eh1+mdjRja600ozwGNsswp8GD4n5+qtHntfTPCEdxes8IN7pOCfvhunkq//SxHk6vR6es6EkINdygxpv0iWLeiV35MW4RofUBlOVGn1G2mZJ29ewyHL1Ry9vGJIUSxEW9gRS+xi3hY4JCRuZLf329G/45oAXlYSypRxlnU1jn1ptkg4XcizgjWpv8sq23abutNRZ3JOiKrvjcFPSbevihF6o7JQv7sdteqd8q8Kkcwno0VOBJ4BM+XiyrTH9qzN+fNnW1zhvdeLxo/PHjx/8BTBUXxA==" \ No newline at end of file diff --git a/docs/assets/main.js b/docs/assets/main.js index 19bbb7a7..64b80ab2 100644 --- a/docs/assets/main.js +++ b/docs/assets/main.js @@ -1,7 +1,7 @@ "use strict"; window.translations={"copy":"Copy","copied":"Copied!","normally_hidden":"This member is normally hidden due to your filter settings.","hierarchy_expand":"Expand","hierarchy_collapse":"Collapse","folder":"Folder","search_index_not_available":"The search index is not available","search_no_results_found_for_0":"No results found for {0}","kind_1":"Project","kind_2":"Module","kind_4":"Namespace","kind_8":"Enumeration","kind_16":"Enumeration Member","kind_32":"Variable","kind_64":"Function","kind_128":"Class","kind_256":"Interface","kind_512":"Constructor","kind_1024":"Property","kind_2048":"Method","kind_4096":"Call Signature","kind_8192":"Index Signature","kind_16384":"Constructor Signature","kind_32768":"Parameter","kind_65536":"Type Literal","kind_131072":"Type Parameter","kind_262144":"Accessor","kind_524288":"Get Signature","kind_1048576":"Set Signature","kind_2097152":"Type Alias","kind_4194304":"Reference","kind_8388608":"Document"}; -"use strict";(()=>{var Ke=Object.create;var he=Object.defineProperty;var Ge=Object.getOwnPropertyDescriptor;var Ze=Object.getOwnPropertyNames;var Xe=Object.getPrototypeOf,Ye=Object.prototype.hasOwnProperty;var et=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var tt=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Ze(e))!Ye.call(t,i)&&i!==n&&he(t,i,{get:()=>e[i],enumerable:!(r=Ge(e,i))||r.enumerable});return t};var nt=(t,e,n)=>(n=t!=null?Ke(Xe(t)):{},tt(e||!t||!t.__esModule?he(n,"default",{value:t,enumerable:!0}):n,t));var ye=et((me,ge)=>{(function(){var t=function(e){var n=new t.Builder;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),n.searchPipeline.add(t.stemmer),e.call(n,n),n.build()};t.version="2.3.9";t.utils={},t.utils.warn=function(e){return function(n){e.console&&console.warn&&console.warn(n)}}(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var n=Object.create(null),r=Object.keys(e),i=0;i0){var d=t.utils.clone(n)||{};d.position=[a,l],d.index=s.length,s.push(new t.Token(r.slice(a,o),d))}a=o+1}}return s},t.tokenizer.separator=/[\s\-]+/;t.Pipeline=function(){this._stack=[]},t.Pipeline.registeredFunctions=Object.create(null),t.Pipeline.registerFunction=function(e,n){n in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+n),e.label=n,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var n=e.label&&e.label in this.registeredFunctions;n||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. -`,e)},t.Pipeline.load=function(e){var n=new t.Pipeline;return e.forEach(function(r){var i=t.Pipeline.registeredFunctions[r];if(i)n.add(i);else throw new Error("Cannot load unregistered function: "+r)}),n},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(n){t.Pipeline.warnIfFunctionNotRegistered(n),this._stack.push(n)},this)},t.Pipeline.prototype.after=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");r=r+1,this._stack.splice(r,0,n)},t.Pipeline.prototype.before=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");this._stack.splice(r,0,n)},t.Pipeline.prototype.remove=function(e){var n=this._stack.indexOf(e);n!=-1&&this._stack.splice(n,1)},t.Pipeline.prototype.run=function(e){for(var n=this._stack.length,r=0;r1&&(oe&&(r=s),o!=e);)i=r-n,s=n+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(oc?d+=2:a==c&&(n+=r[l+1]*i[d+1],l+=2,d+=2);return n},t.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},t.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),n=1,r=0;n0){var o=s.str.charAt(0),a;o in s.node.edges?a=s.node.edges[o]:(a=new t.TokenSet,s.node.edges[o]=a),s.str.length==1&&(a.final=!0),i.push({node:a,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(s.editsRemaining!=0){if("*"in s.node.edges)var c=s.node.edges["*"];else{var c=new t.TokenSet;s.node.edges["*"]=c}if(s.str.length==0&&(c.final=!0),i.push({node:c,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&i.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),s.str.length==1&&(s.node.final=!0),s.str.length>=1){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}s.str.length==1&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var d=s.str.charAt(0),f=s.str.charAt(1),p;f in s.node.edges?p=s.node.edges[f]:(p=new t.TokenSet,s.node.edges[f]=p),s.str.length==1&&(p.final=!0),i.push({node:p,editsRemaining:s.editsRemaining-1,str:d+s.str.slice(2)})}}}return r},t.TokenSet.fromString=function(e){for(var n=new t.TokenSet,r=n,i=0,s=e.length;i=e;n--){var r=this.uncheckedNodes[n],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r.char]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}};t.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},t.Index.prototype.search=function(e){return this.query(function(n){var r=new t.QueryParser(e,n);r.parse()})},t.Index.prototype.query=function(e){for(var n=new t.Query(this.fields),r=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),c=0;c1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,n){var r=e[this._ref],i=Object.keys(this._fields);this._documents[r]=n||{},this.documentCount+=1;for(var s=0;s=this.length)return t.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},t.QueryLexer.prototype.width=function(){return this.pos-this.start},t.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},t.QueryLexer.prototype.backup=function(){this.pos-=1},t.QueryLexer.prototype.acceptDigitRun=function(){var e,n;do e=this.next(),n=e.charCodeAt(0);while(n>47&&n<58);e!=t.QueryLexer.EOS&&this.backup()},t.QueryLexer.prototype.more=function(){return this.pos1&&(e.backup(),e.emit(t.QueryLexer.TERM)),e.ignore(),e.more())return t.QueryLexer.lexText},t.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.EDIT_DISTANCE),t.QueryLexer.lexText},t.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.BOOST),t.QueryLexer.lexText},t.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(t.QueryLexer.TERM)},t.QueryLexer.termSeparator=t.tokenizer.separator,t.QueryLexer.lexText=function(e){for(;;){var n=e.next();if(n==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(n.charCodeAt(0)==92){e.escapeCharacter();continue}if(n==":")return t.QueryLexer.lexField;if(n=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(n=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(n=="+"&&e.width()===1||n=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(n.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,n){this.lexer=new t.QueryLexer(e),this.query=n,this.currentClause={},this.lexemeIdx=0},t.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=t.QueryParser.parseClause;e;)e=e(this);return this.query},t.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},t.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},t.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},t.QueryParser.parseClause=function(e){var n=e.peekLexeme();if(n!=null)switch(n.type){case t.QueryLexer.PRESENCE:return t.QueryParser.parsePresence;case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expected either a field or a term, found "+n.type;throw n.str.length>=1&&(r+=" with value '"+n.str+"'"),new t.QueryParseError(r,n.start,n.end)}},t.QueryParser.parsePresence=function(e){var n=e.consumeLexeme();if(n!=null){switch(n.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var r="unrecognised presence operator'"+n.str+"'";throw new t.QueryParseError(r,n.start,n.end)}var i=e.peekLexeme();if(i==null){var r="expecting term or field, found nothing";throw new t.QueryParseError(r,n.start,n.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(r,i.start,i.end)}}},t.QueryParser.parseField=function(e){var n=e.consumeLexeme();if(n!=null){if(e.query.allFields.indexOf(n.str)==-1){var r=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+n.str+"', possible fields: "+r;throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.fields=[n.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,n.start,n.end)}switch(s.type){case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var i="expecting term, found '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseTerm=function(e){var n=e.consumeLexeme();if(n!=null){e.currentClause.term=n.str.toLowerCase(),n.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var r=e.peekLexeme();if(r==null){e.nextClause();return}switch(r.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+r.type+"'";throw new t.QueryParseError(i,r.start,r.end)}}},t.QueryParser.parseEditDistance=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="edit distance must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.editDistance=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseBoost=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="boost must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.boost=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},function(e,n){typeof define=="function"&&define.amd?define(n):typeof me=="object"?ge.exports=n():e.lunr=n()}(this,function(){return t})})()});var M,G={getItem(){return null},setItem(){}},K;try{K=localStorage,M=K}catch{K=G,M=G}var S={getItem:t=>M.getItem(t),setItem:(t,e)=>M.setItem(t,e),disableWritingLocalStorage(){M=G},disable(){localStorage.clear(),M=G},enable(){M=K}};window.TypeDoc||={disableWritingLocalStorage(){S.disableWritingLocalStorage()},disableLocalStorage:()=>{S.disable()},enableLocalStorage:()=>{S.enable()}};window.translations||={copy:"Copy",copied:"Copied!",normally_hidden:"This member is normally hidden due to your filter settings.",hierarchy_expand:"Expand",hierarchy_collapse:"Collapse",search_index_not_available:"The search index is not available",search_no_results_found_for_0:"No results found for {0}",folder:"Folder",kind_1:"Project",kind_2:"Module",kind_4:"Namespace",kind_8:"Enumeration",kind_16:"Enumeration Member",kind_32:"Variable",kind_64:"Function",kind_128:"Class",kind_256:"Interface",kind_512:"Constructor",kind_1024:"Property",kind_2048:"Method",kind_4096:"Call Signature",kind_8192:"Index Signature",kind_16384:"Constructor Signature",kind_32768:"Parameter",kind_65536:"Type Literal",kind_131072:"Type Parameter",kind_262144:"Accessor",kind_524288:"Get Signature",kind_1048576:"Set Signature",kind_2097152:"Type Alias",kind_4194304:"Reference",kind_8388608:"Document"};var pe=[];function X(t,e){pe.push({selector:e,constructor:t})}var Z=class{alwaysVisibleMember=null;constructor(){this.createComponents(document.body),this.ensureFocusedElementVisible(),this.listenForCodeCopies(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible()),document.body.style.display||(this.ensureFocusedElementVisible(),this.updateIndexVisibility(),this.scrollToHash())}createComponents(e){pe.forEach(n=>{e.querySelectorAll(n.selector).forEach(r=>{r.dataset.hasInstance||(new n.constructor({el:r,app:this}),r.dataset.hasInstance=String(!0))})})}filterChanged(){this.ensureFocusedElementVisible()}showPage(){document.body.style.display&&(document.body.style.removeProperty("display"),this.ensureFocusedElementVisible(),this.updateIndexVisibility(),this.scrollToHash())}scrollToHash(){if(location.hash){let e=document.getElementById(location.hash.substring(1));if(!e)return;e.scrollIntoView({behavior:"instant",block:"start"})}}ensureActivePageVisible(){let e=document.querySelector(".tsd-navigation .current"),n=e?.parentElement;for(;n&&!n.classList.contains(".tsd-navigation");)n instanceof HTMLDetailsElement&&(n.open=!0),n=n.parentElement;if(e&&!rt(e)){let r=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").scrollTop=r,document.querySelector(".col-sidebar").scrollTop=r}}updateIndexVisibility(){let e=document.querySelector(".tsd-index-content"),n=e?.open;e&&(e.open=!0),document.querySelectorAll(".tsd-index-section").forEach(r=>{r.style.display="block";let i=Array.from(r.querySelectorAll(".tsd-index-link")).every(s=>s.offsetParent==null);r.style.display=i?"none":"block"}),e&&(e.open=n)}ensureFocusedElementVisible(){if(this.alwaysVisibleMember&&(this.alwaysVisibleMember.classList.remove("always-visible"),this.alwaysVisibleMember.firstElementChild.remove(),this.alwaysVisibleMember=null),!location.hash)return;let e=document.getElementById(location.hash.substring(1));if(!e)return;let n=e.parentElement;for(;n&&n.tagName!=="SECTION";)n=n.parentElement;if(!n)return;let r=n.offsetParent==null,i=n;for(;i!==document.body;)i instanceof HTMLDetailsElement&&(i.open=!0),i=i.parentElement;if(n.offsetParent==null){this.alwaysVisibleMember=n,n.classList.add("always-visible");let s=document.createElement("p");s.classList.add("warning"),s.textContent=window.translations.normally_hidden,n.prepend(s)}r&&e.scrollIntoView()}listenForCodeCopies(){document.querySelectorAll("pre > button").forEach(e=>{let n;e.addEventListener("click",()=>{e.previousElementSibling instanceof HTMLElement&&navigator.clipboard.writeText(e.previousElementSibling.innerText.trim()),e.textContent=window.translations.copied,e.classList.add("visible"),clearTimeout(n),n=setTimeout(()=>{e.classList.remove("visible"),n=setTimeout(()=>{e.textContent=window.translations.copy},100)},1e3)})})}};function rt(t){let e=t.getBoundingClientRect(),n=Math.max(document.documentElement.clientHeight,window.innerHeight);return!(e.bottom<0||e.top-n>=0)}var fe=(t,e=100)=>{let n;return()=>{clearTimeout(n),n=setTimeout(()=>t(),e)}};var Ie=nt(ye(),1);async function R(t){let e=Uint8Array.from(atob(t),s=>s.charCodeAt(0)),r=new Blob([e]).stream().pipeThrough(new DecompressionStream("deflate")),i=await new Response(r).text();return JSON.parse(i)}var Y="closing",ae="tsd-overlay";function it(){let t=Math.abs(window.innerWidth-document.documentElement.clientWidth);document.body.style.overflow="hidden",document.body.style.paddingRight=`${t}px`}function st(){document.body.style.removeProperty("overflow"),document.body.style.removeProperty("padding-right")}function xe(t,e){t.addEventListener("animationend",()=>{t.classList.contains(Y)&&(t.classList.remove(Y),document.getElementById(ae)?.remove(),t.close(),st())}),t.addEventListener("cancel",n=>{n.preventDefault(),ve(t)}),e?.closeOnClick&&document.addEventListener("click",n=>{t.open&&!t.contains(n.target)&&ve(t)},!0)}function Ee(t){if(t.open)return;let e=document.createElement("div");e.id=ae,document.body.appendChild(e),t.showModal(),it()}function ve(t){if(!t.open)return;document.getElementById(ae)?.classList.add(Y),t.classList.add(Y)}var I=class{el;app;constructor(e){this.el=e.el,this.app=e.app}};var be=document.head.appendChild(document.createElement("style"));be.dataset.for="filters";var le={};function we(t){for(let e of t.split(/\s+/))if(le.hasOwnProperty(e)&&!le[e])return!0;return!1}var ee=class extends I{key;value;constructor(e){super(e),this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),be.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } +"use strict";(()=>{var Ke=Object.create;var he=Object.defineProperty;var Ge=Object.getOwnPropertyDescriptor;var Ze=Object.getOwnPropertyNames;var Xe=Object.getPrototypeOf,Ye=Object.prototype.hasOwnProperty;var et=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var tt=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Ze(e))!Ye.call(t,i)&&i!==n&&he(t,i,{get:()=>e[i],enumerable:!(r=Ge(e,i))||r.enumerable});return t};var nt=(t,e,n)=>(n=t!=null?Ke(Xe(t)):{},tt(e||!t||!t.__esModule?he(n,"default",{value:t,enumerable:!0}):n,t));var ye=et((me,ge)=>{(function(){var t=function(e){var n=new t.Builder;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),n.searchPipeline.add(t.stemmer),e.call(n,n),n.build()};t.version="2.3.9";t.utils={},t.utils.warn=(function(e){return function(n){e.console&&console.warn&&console.warn(n)}})(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var n=Object.create(null),r=Object.keys(e),i=0;i0){var d=t.utils.clone(n)||{};d.position=[a,l],d.index=s.length,s.push(new t.Token(r.slice(a,o),d))}a=o+1}}return s},t.tokenizer.separator=/[\s\-]+/;t.Pipeline=function(){this._stack=[]},t.Pipeline.registeredFunctions=Object.create(null),t.Pipeline.registerFunction=function(e,n){n in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+n),e.label=n,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var n=e.label&&e.label in this.registeredFunctions;n||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. +`,e)},t.Pipeline.load=function(e){var n=new t.Pipeline;return e.forEach(function(r){var i=t.Pipeline.registeredFunctions[r];if(i)n.add(i);else throw new Error("Cannot load unregistered function: "+r)}),n},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(n){t.Pipeline.warnIfFunctionNotRegistered(n),this._stack.push(n)},this)},t.Pipeline.prototype.after=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");r=r+1,this._stack.splice(r,0,n)},t.Pipeline.prototype.before=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");this._stack.splice(r,0,n)},t.Pipeline.prototype.remove=function(e){var n=this._stack.indexOf(e);n!=-1&&this._stack.splice(n,1)},t.Pipeline.prototype.run=function(e){for(var n=this._stack.length,r=0;r1&&(oe&&(r=s),o!=e);)i=r-n,s=n+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(oc?d+=2:a==c&&(n+=r[l+1]*i[d+1],l+=2,d+=2);return n},t.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},t.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),n=1,r=0;n0){var o=s.str.charAt(0),a;o in s.node.edges?a=s.node.edges[o]:(a=new t.TokenSet,s.node.edges[o]=a),s.str.length==1&&(a.final=!0),i.push({node:a,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(s.editsRemaining!=0){if("*"in s.node.edges)var c=s.node.edges["*"];else{var c=new t.TokenSet;s.node.edges["*"]=c}if(s.str.length==0&&(c.final=!0),i.push({node:c,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&i.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),s.str.length==1&&(s.node.final=!0),s.str.length>=1){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}s.str.length==1&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var d=s.str.charAt(0),f=s.str.charAt(1),p;f in s.node.edges?p=s.node.edges[f]:(p=new t.TokenSet,s.node.edges[f]=p),s.str.length==1&&(p.final=!0),i.push({node:p,editsRemaining:s.editsRemaining-1,str:d+s.str.slice(2)})}}}return r},t.TokenSet.fromString=function(e){for(var n=new t.TokenSet,r=n,i=0,s=e.length;i=e;n--){var r=this.uncheckedNodes[n],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r.char]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}};t.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},t.Index.prototype.search=function(e){return this.query(function(n){var r=new t.QueryParser(e,n);r.parse()})},t.Index.prototype.query=function(e){for(var n=new t.Query(this.fields),r=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),c=0;c1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,n){var r=e[this._ref],i=Object.keys(this._fields);this._documents[r]=n||{},this.documentCount+=1;for(var s=0;s=this.length)return t.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},t.QueryLexer.prototype.width=function(){return this.pos-this.start},t.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},t.QueryLexer.prototype.backup=function(){this.pos-=1},t.QueryLexer.prototype.acceptDigitRun=function(){var e,n;do e=this.next(),n=e.charCodeAt(0);while(n>47&&n<58);e!=t.QueryLexer.EOS&&this.backup()},t.QueryLexer.prototype.more=function(){return this.pos1&&(e.backup(),e.emit(t.QueryLexer.TERM)),e.ignore(),e.more())return t.QueryLexer.lexText},t.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.EDIT_DISTANCE),t.QueryLexer.lexText},t.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.BOOST),t.QueryLexer.lexText},t.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(t.QueryLexer.TERM)},t.QueryLexer.termSeparator=t.tokenizer.separator,t.QueryLexer.lexText=function(e){for(;;){var n=e.next();if(n==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(n.charCodeAt(0)==92){e.escapeCharacter();continue}if(n==":")return t.QueryLexer.lexField;if(n=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(n=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(n=="+"&&e.width()===1||n=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(n.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,n){this.lexer=new t.QueryLexer(e),this.query=n,this.currentClause={},this.lexemeIdx=0},t.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=t.QueryParser.parseClause;e;)e=e(this);return this.query},t.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},t.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},t.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},t.QueryParser.parseClause=function(e){var n=e.peekLexeme();if(n!=null)switch(n.type){case t.QueryLexer.PRESENCE:return t.QueryParser.parsePresence;case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expected either a field or a term, found "+n.type;throw n.str.length>=1&&(r+=" with value '"+n.str+"'"),new t.QueryParseError(r,n.start,n.end)}},t.QueryParser.parsePresence=function(e){var n=e.consumeLexeme();if(n!=null){switch(n.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var r="unrecognised presence operator'"+n.str+"'";throw new t.QueryParseError(r,n.start,n.end)}var i=e.peekLexeme();if(i==null){var r="expecting term or field, found nothing";throw new t.QueryParseError(r,n.start,n.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(r,i.start,i.end)}}},t.QueryParser.parseField=function(e){var n=e.consumeLexeme();if(n!=null){if(e.query.allFields.indexOf(n.str)==-1){var r=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+n.str+"', possible fields: "+r;throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.fields=[n.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,n.start,n.end)}switch(s.type){case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var i="expecting term, found '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseTerm=function(e){var n=e.consumeLexeme();if(n!=null){e.currentClause.term=n.str.toLowerCase(),n.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var r=e.peekLexeme();if(r==null){e.nextClause();return}switch(r.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+r.type+"'";throw new t.QueryParseError(i,r.start,r.end)}}},t.QueryParser.parseEditDistance=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="edit distance must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.editDistance=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseBoost=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="boost must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.boost=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},(function(e,n){typeof define=="function"&&define.amd?define(n):typeof me=="object"?ge.exports=n():e.lunr=n()})(this,function(){return t})})()});var M,G={getItem(){return null},setItem(){}},K;try{K=localStorage,M=K}catch{K=G,M=G}var S={getItem:t=>M.getItem(t),setItem:(t,e)=>M.setItem(t,e),disableWritingLocalStorage(){M=G},disable(){localStorage.clear(),M=G},enable(){M=K}};window.TypeDoc||={disableWritingLocalStorage(){S.disableWritingLocalStorage()},disableLocalStorage:()=>{S.disable()},enableLocalStorage:()=>{S.enable()}};window.translations||={copy:"Copy",copied:"Copied!",normally_hidden:"This member is normally hidden due to your filter settings.",hierarchy_expand:"Expand",hierarchy_collapse:"Collapse",search_index_not_available:"The search index is not available",search_no_results_found_for_0:"No results found for {0}",folder:"Folder",kind_1:"Project",kind_2:"Module",kind_4:"Namespace",kind_8:"Enumeration",kind_16:"Enumeration Member",kind_32:"Variable",kind_64:"Function",kind_128:"Class",kind_256:"Interface",kind_512:"Constructor",kind_1024:"Property",kind_2048:"Method",kind_4096:"Call Signature",kind_8192:"Index Signature",kind_16384:"Constructor Signature",kind_32768:"Parameter",kind_65536:"Type Literal",kind_131072:"Type Parameter",kind_262144:"Accessor",kind_524288:"Get Signature",kind_1048576:"Set Signature",kind_2097152:"Type Alias",kind_4194304:"Reference",kind_8388608:"Document"};var pe=[];function X(t,e){pe.push({selector:e,constructor:t})}var Z=class{alwaysVisibleMember=null;constructor(){this.createComponents(document.body),this.ensureFocusedElementVisible(),this.listenForCodeCopies(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible()),document.body.style.display||(this.ensureFocusedElementVisible(),this.updateIndexVisibility(),this.scrollToHash())}createComponents(e){pe.forEach(n=>{e.querySelectorAll(n.selector).forEach(r=>{r.dataset.hasInstance||(new n.constructor({el:r,app:this}),r.dataset.hasInstance=String(!0))})})}filterChanged(){this.ensureFocusedElementVisible()}showPage(){document.body.style.display&&(document.body.style.removeProperty("display"),this.ensureFocusedElementVisible(),this.updateIndexVisibility(),this.scrollToHash())}scrollToHash(){if(location.hash){let e=document.getElementById(location.hash.substring(1));if(!e)return;e.scrollIntoView({behavior:"instant",block:"start"})}}ensureActivePageVisible(){let e=document.querySelector(".tsd-navigation .current"),n=e?.parentElement;for(;n&&!n.classList.contains(".tsd-navigation");)n instanceof HTMLDetailsElement&&(n.open=!0),n=n.parentElement;if(e&&!rt(e)){let r=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").scrollTop=r,document.querySelector(".col-sidebar").scrollTop=r}}updateIndexVisibility(){let e=document.querySelector(".tsd-index-content"),n=e?.open;e&&(e.open=!0),document.querySelectorAll(".tsd-index-section").forEach(r=>{r.style.display="block";let i=Array.from(r.querySelectorAll(".tsd-index-link")).every(s=>s.offsetParent==null);r.style.display=i?"none":"block"}),e&&(e.open=n)}ensureFocusedElementVisible(){if(this.alwaysVisibleMember&&(this.alwaysVisibleMember.classList.remove("always-visible"),this.alwaysVisibleMember.firstElementChild.remove(),this.alwaysVisibleMember=null),!location.hash)return;let e=document.getElementById(location.hash.substring(1));if(!e)return;let n=e.parentElement;for(;n&&n.tagName!=="SECTION";)n=n.parentElement;if(!n)return;let r=n.offsetParent==null,i=n;for(;i!==document.body;)i instanceof HTMLDetailsElement&&(i.open=!0),i=i.parentElement;if(n.offsetParent==null){this.alwaysVisibleMember=n,n.classList.add("always-visible");let s=document.createElement("p");s.classList.add("warning"),s.textContent=window.translations.normally_hidden,n.prepend(s)}r&&e.scrollIntoView()}listenForCodeCopies(){document.querySelectorAll("pre > button").forEach(e=>{let n;e.addEventListener("click",()=>{e.previousElementSibling instanceof HTMLElement&&navigator.clipboard.writeText(e.previousElementSibling.innerText.trim()),e.textContent=window.translations.copied,e.classList.add("visible"),clearTimeout(n),n=setTimeout(()=>{e.classList.remove("visible"),n=setTimeout(()=>{e.textContent=window.translations.copy},100)},1e3)})})}};function rt(t){let e=t.getBoundingClientRect(),n=Math.max(document.documentElement.clientHeight,window.innerHeight);return!(e.bottom<0||e.top-n>=0)}var fe=(t,e=100)=>{let n;return()=>{clearTimeout(n),n=setTimeout(()=>t(),e)}};var Ie=nt(ye(),1);async function R(t){let e=Uint8Array.from(atob(t),s=>s.charCodeAt(0)),r=new Blob([e]).stream().pipeThrough(new DecompressionStream("deflate")),i=await new Response(r).text();return JSON.parse(i)}var Y="closing",ae="tsd-overlay";function it(){let t=Math.abs(window.innerWidth-document.documentElement.clientWidth);document.body.style.overflow="hidden",document.body.style.paddingRight=`${t}px`}function st(){document.body.style.removeProperty("overflow"),document.body.style.removeProperty("padding-right")}function xe(t,e){t.addEventListener("animationend",()=>{t.classList.contains(Y)&&(t.classList.remove(Y),document.getElementById(ae)?.remove(),t.close(),st())}),t.addEventListener("cancel",n=>{n.preventDefault(),ve(t)}),e?.closeOnClick&&document.addEventListener("click",n=>{t.open&&!t.contains(n.target)&&ve(t)},!0)}function Ee(t){if(t.open)return;let e=document.createElement("div");e.id=ae,document.body.appendChild(e),t.showModal(),it()}function ve(t){if(!t.open)return;document.getElementById(ae)?.classList.add(Y),t.classList.add(Y)}var I=class{el;app;constructor(e){this.el=e.el,this.app=e.app}};var be=document.head.appendChild(document.createElement("style"));be.dataset.for="filters";var le={};function we(t){for(let e of t.split(/\s+/))if(le.hasOwnProperty(e)&&!le[e])return!0;return!1}var ee=class extends I{key;value;constructor(e){super(e),this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),be.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } `,this.app.updateIndexVisibility()}fromLocalStorage(){let e=S.getItem(this.key);return e?e==="true":this.el.checked}setLocalStorage(e){S.setItem(this.key,e.toString()),this.value=e,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),le[`tsd-is-${this.el.name}`]=this.value,this.app.filterChanged(),this.app.updateIndexVisibility()}};var Le=0;async function Se(t,e){if(!window.searchData)return;let n=await R(window.searchData);t.data=n,t.index=Ie.Index.load(n.index),e.innerHTML=""}function _e(){let t=document.getElementById("tsd-search-trigger"),e=document.getElementById("tsd-search"),n=document.getElementById("tsd-search-input"),r=document.getElementById("tsd-search-results"),i=document.getElementById("tsd-search-script"),s=document.getElementById("tsd-search-status");if(!(t&&e&&n&&r&&i&&s))throw new Error("Search controls missing");let o={base:document.documentElement.dataset.base};o.base.endsWith("/")||(o.base+="/"),i.addEventListener("error",()=>{let a=window.translations.search_index_not_available;Pe(s,a)}),i.addEventListener("load",()=>{Se(o,s)}),Se(o,s),ot({trigger:t,searchEl:e,results:r,field:n,status:s},o)}function ot(t,e){let{field:n,results:r,searchEl:i,status:s,trigger:o}=t;xe(i,{closeOnClick:!0});function a(){Ee(i),n.setSelectionRange(0,n.value.length)}o.addEventListener("click",a),n.addEventListener("input",fe(()=>{at(r,n,s,e)},200)),n.addEventListener("keydown",l=>{if(r.childElementCount===0||l.ctrlKey||l.metaKey||l.altKey)return;let d=n.getAttribute("aria-activedescendant"),f=d?document.getElementById(d):null;if(f){let p=!1,v=!1;switch(l.key){case"Home":case"End":case"ArrowLeft":case"ArrowRight":v=!0;break;case"ArrowDown":case"ArrowUp":p=l.shiftKey;break}(p||v)&&ke(n)}if(!l.shiftKey)switch(l.key){case"Enter":f?.querySelector("a")?.click();break;case"ArrowUp":Te(r,n,f,-1),l.preventDefault();break;case"ArrowDown":Te(r,n,f,1),l.preventDefault();break}});function c(){ke(n)}n.addEventListener("change",c),n.addEventListener("blur",c),n.addEventListener("click",c),document.body.addEventListener("keydown",l=>{if(l.altKey||l.metaKey||l.shiftKey)return;let d=l.ctrlKey&&l.key==="k",f=!l.ctrlKey&&!ut()&&l.key==="/";(d||f)&&(l.preventDefault(),a())})}function at(t,e,n,r){if(!r.index||!r.data)return;t.innerHTML="",n.innerHTML="",Le+=1;let i=e.value.trim(),s;if(i){let a=i.split(" ").map(c=>c.length?`*${c}*`:"").join(" ");s=r.index.search(a).filter(({ref:c})=>{let l=r.data.rows[Number(c)].classes;return!l||!we(l)})}else s=[];if(s.length===0&&i){let a=window.translations.search_no_results_found_for_0.replace("{0}",` "${te(i)}" `);Pe(n,a);return}for(let a=0;ac.score-a.score);let o=Math.min(10,s.length);for(let a=0;a`,f=Ce(c.name,i);globalThis.DEBUG_SEARCH_WEIGHTS&&(f+=` (score: ${s[a].score.toFixed(2)})`),c.parent&&(f=` ${Ce(c.parent,i)}.${f}`);let p=document.createElement("li");p.id=`tsd-search:${Le}-${a}`,p.role="option",p.ariaSelected="false",p.classList.value=c.classes??"";let v=document.createElement("a");v.tabIndex=-1,v.href=r.base+c.url,v.innerHTML=d+`${f}`,p.append(v),t.appendChild(p)}}function Te(t,e,n,r){let i;if(r===1?i=n?.nextElementSibling||t.firstElementChild:i=n?.previousElementSibling||t.lastElementChild,i!==n){if(!i||i.role!=="option"){console.error("Option missing");return}i.ariaSelected="true",i.scrollIntoView({behavior:"smooth",block:"nearest"}),e.setAttribute("aria-activedescendant",i.id),n?.setAttribute("aria-selected","false")}}function ke(t){let e=t.getAttribute("aria-activedescendant");(e?document.getElementById(e):null)?.setAttribute("aria-selected","false"),t.setAttribute("aria-activedescendant","")}function Ce(t,e){if(e==="")return t;let n=t.toLocaleLowerCase(),r=e.toLocaleLowerCase(),i=[],s=0,o=n.indexOf(r);for(;o!=-1;)i.push(te(t.substring(s,o)),`${te(t.substring(o,o+r.length))}`),s=o+r.length,o=n.indexOf(r,s);return i.push(te(t.substring(s))),i.join("")}var lt={"&":"&","<":"<",">":">","'":"'",'"':"""};function te(t){return t.replace(/[&<>"'"]/g,e=>lt[e])}function Pe(t,e){t.innerHTML=e?`
${e}
`:""}var ct=["button","checkbox","file","hidden","image","radio","range","reset","submit"];function ut(){let t=document.activeElement;return t?t.isContentEditable||t.tagName==="TEXTAREA"||t.tagName==="SEARCH"?!0:t.tagName==="INPUT"&&!ct.includes(t.type):!1}var D="mousedown",Me="mousemove",$="mouseup",ne={x:0,y:0},Qe=!1,ce=!1,dt=!1,F=!1,Oe=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(Oe?"is-mobile":"not-mobile");Oe&&"ontouchstart"in document.documentElement&&(dt=!0,D="touchstart",Me="touchmove",$="touchend");document.addEventListener(D,t=>{ce=!0,F=!1;let e=D=="touchstart"?t.targetTouches[0]:t;ne.y=e.pageY||0,ne.x=e.pageX||0});document.addEventListener(Me,t=>{if(ce&&!F){let e=D=="touchstart"?t.targetTouches[0]:t,n=ne.x-(e.pageX||0),r=ne.y-(e.pageY||0);F=Math.sqrt(n*n+r*r)>10}});document.addEventListener($,()=>{ce=!1});document.addEventListener("click",t=>{Qe&&(t.preventDefault(),t.stopImmediatePropagation(),Qe=!1)});var re=class extends I{active;className;constructor(e){super(e),this.className=this.el.dataset.toggle||"",this.el.addEventListener($,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(D,n=>this.onDocumentPointerDown(n)),document.addEventListener($,n=>this.onDocumentPointerUp(n))}setActive(e){if(this.active==e)return;this.active=e,document.documentElement.classList.toggle("has-"+this.className,e),this.el.classList.toggle("active",e);let n=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(n),setTimeout(()=>document.documentElement.classList.remove(n),500)}onPointerUp(e){F||(this.setActive(!0),e.preventDefault())}onDocumentPointerDown(e){if(this.active){if(e.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(e){if(!F&&this.active&&e.target.closest(".col-sidebar")){let n=e.target.closest("a");if(n){let r=window.location.href;r.indexOf("#")!=-1&&(r=r.substring(0,r.indexOf("#"))),n.href.substring(0,r.length)==r&&setTimeout(()=>this.setActive(!1),250)}}}};var ue=new Map,de=class{open;accordions=[];key;constructor(e,n){this.key=e,this.open=n}add(e){this.accordions.push(e),e.open=this.open,e.addEventListener("toggle",()=>{this.toggle(e.open)})}toggle(e){for(let n of this.accordions)n.open=e;S.setItem(this.key,e.toString())}},ie=class extends I{constructor(e){super(e);let n=this.el.querySelector("summary"),r=n.querySelector("a");r&&r.addEventListener("click",()=>{location.assign(r.href)});let i=`tsd-accordion-${n.dataset.key??n.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`,s;if(ue.has(i))s=ue.get(i);else{let o=S.getItem(i),a=o?o==="true":this.el.open;s=new de(i,a),ue.set(i,s)}s.add(this.el)}};function He(t){let e=S.getItem("tsd-theme")||"os";t.value=e,Ae(e),t.addEventListener("change",()=>{S.setItem("tsd-theme",t.value),Ae(t.value)})}function Ae(t){document.documentElement.dataset.theme=t}var se;function Ne(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",Re),Re())}async function Re(){let t=document.getElementById("tsd-nav-container");if(!t||!window.navigationData)return;let e=await R(window.navigationData);se=document.documentElement.dataset.base,se.endsWith("/")||(se+="/"),t.innerHTML="";for(let n of e)Be(n,t,[]);window.app.createComponents(t),window.app.showPage(),window.app.ensureActivePageVisible()}function Be(t,e,n){let r=e.appendChild(document.createElement("li"));if(t.children){let i=[...n,t.text],s=r.appendChild(document.createElement("details"));s.className=t.class?`${t.class} tsd-accordion`:"tsd-accordion";let o=s.appendChild(document.createElement("summary"));o.className="tsd-accordion-summary",o.dataset.key=i.join("$"),o.innerHTML='',De(t,o);let a=s.appendChild(document.createElement("div"));a.className="tsd-accordion-details";let c=a.appendChild(document.createElement("ul"));c.className="tsd-nested-navigation";for(let l of t.children)Be(l,c,i)}else De(t,r,t.class)}function De(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));if(r.href=se+t.path,n&&(r.className=n),location.pathname===r.pathname&&!r.href.includes("#")&&(r.classList.add("current"),r.ariaCurrent="page"),t.kind){let i=window.translations[`kind_${t.kind}`].replaceAll('"',""");r.innerHTML=``}r.appendChild(Fe(t.text,document.createElement("span")))}else{let r=e.appendChild(document.createElement("span")),i=window.translations.folder.replaceAll('"',""");r.innerHTML=``,r.appendChild(Fe(t.text,document.createElement("span")))}}function Fe(t,e){let n=t.split(/(?<=[^A-Z])(?=[A-Z])|(?<=[A-Z])(?=[A-Z][a-z])|(?<=[_-])(?=[^_-])/);for(let r=0;r{let i=r.target;for(;i.parentElement&&i.parentElement.tagName!="LI";)i=i.parentElement;i.dataset.dropdown&&(i.dataset.dropdown=String(i.dataset.dropdown!=="true"))});let t=new Map,e=new Set;for(let r of document.querySelectorAll(".tsd-full-hierarchy [data-refl]")){let i=r.querySelector("ul");t.has(r.dataset.refl)?e.add(r.dataset.refl):i&&t.set(r.dataset.refl,i)}for(let r of e)n(r);function n(r){let i=t.get(r).cloneNode(!0);i.querySelectorAll("[id]").forEach(s=>{s.removeAttribute("id")}),i.querySelectorAll("[data-dropdown]").forEach(s=>{s.dataset.dropdown="false"});for(let s of document.querySelectorAll(`[data-refl="${r}"]`)){let o=gt(),a=s.querySelector("ul");s.insertBefore(o,a),o.dataset.dropdown=String(!!a),a||s.appendChild(i.cloneNode(!0))}}}function pt(){let t=document.getElementById("tsd-hierarchy-script");t&&(t.addEventListener("load",Ve),Ve())}async function Ve(){let t=document.querySelector(".tsd-panel.tsd-hierarchy:has(h4 a)");if(!t||!window.hierarchyData)return;let e=+t.dataset.refl,n=await R(window.hierarchyData),r=t.querySelector("ul"),i=document.createElement("ul");if(i.classList.add("tsd-hierarchy"),ft(i,n,e),r.querySelectorAll("li").length==i.querySelectorAll("li").length)return;let s=document.createElement("span");s.classList.add("tsd-hierarchy-toggle"),s.textContent=window.translations.hierarchy_expand,t.querySelector("h4 a")?.insertAdjacentElement("afterend",s),s.insertAdjacentText("beforebegin",", "),s.addEventListener("click",()=>{s.textContent===window.translations.hierarchy_expand?(r.insertAdjacentElement("afterend",i),r.remove(),s.textContent=window.translations.hierarchy_collapse):(i.insertAdjacentElement("afterend",r),i.remove(),s.textContent=window.translations.hierarchy_expand)})}function ft(t,e,n){let r=e.roots.filter(i=>mt(e,i,n));for(let i of r)t.appendChild(je(e,i,n))}function je(t,e,n,r=new Set){if(r.has(e))return;r.add(e);let i=t.reflections[e],s=document.createElement("li");if(s.classList.add("tsd-hierarchy-item"),e===n){let o=s.appendChild(document.createElement("span"));o.textContent=i.name,o.classList.add("tsd-hierarchy-target")}else{for(let a of i.uniqueNameParents||[]){let c=t.reflections[a],l=s.appendChild(document.createElement("a"));l.textContent=c.name,l.href=oe+c.url,l.className=c.class+" tsd-signature-type",s.append(document.createTextNode("."))}let o=s.appendChild(document.createElement("a"));o.textContent=t.reflections[e].name,o.href=oe+i.url,o.className=i.class+" tsd-signature-type"}if(i.children){let o=s.appendChild(document.createElement("ul"));o.classList.add("tsd-hierarchy");for(let a of i.children){let c=je(t,a,n,r);c&&o.appendChild(c)}}return r.delete(e),s}function mt(t,e,n){if(e===n)return!0;let r=new Set,i=[t.reflections[e]];for(;i.length;){let s=i.pop();if(!r.has(s)){r.add(s);for(let o of s.children||[]){if(o===n)return!0;i.push(t.reflections[o])}}}return!1}function gt(){let t=document.createElementNS("http://www.w3.org/2000/svg","svg");return t.setAttribute("width","20"),t.setAttribute("height","20"),t.setAttribute("viewBox","0 0 24 24"),t.setAttribute("fill","none"),t.innerHTML='',t}X(re,"a[data-toggle]");X(ie,".tsd-accordion");X(ee,".tsd-filter-item input[type=checkbox]");var qe=document.getElementById("tsd-theme");qe&&He(qe);var yt=new Z;Object.defineProperty(window,"app",{value:yt});_e();Ne();$e();"virtualKeyboard"in navigator&&(navigator.virtualKeyboard.overlaysContent=!0);})(); /*! Bundled license information: diff --git a/docs/assets/navigation.js b/docs/assets/navigation.js index d4cce4a6..bc2a1f15 100644 --- a/docs/assets/navigation.js +++ b/docs/assets/navigation.js @@ -1 +1 @@ -window.navigationData = "eJzFnWtv5LaShv/KwudrsslcMuckWCzga9KJPe64PZMNDoIBR2J3c62mFIqy3Vmc/76gLt2iRJHFKnnOp8G436qnJFEUr8V//t+J5s/65IeT/xJScyVZ9t8nX50UTG9PfjjZ5WmV8fKbT91vn/5zq3fZyVcnD0KmJz+8/uok2YosVVye/PDPg6vTTLDS66VW2L7efnWSZKwsT3440WX6tSi/5s+N/MRNWTJV8hSI+VvRqVvaq+/fvvnWw/zXH//66oC6yJNqx6X2wjrRzJdVA9YsmYA18sFj+e4d8MIuH7nUlzuhNVfei+sLiRfYd3Va7mVyx8u8Ugk/BlA79AQw6cIO7dXrf3juw/EunH7OlWafMx6661YQB6uYm+++9dY13BZa5LKMiiXkjB7iHV9zxWUi5GbioUWGOeWQHmpcQf4bN3/hB1NM/bBKWMb83EZCfHXOrm/Pf/l0dXt9cXlxpOl94WT11YO7+u33f3/13WvQnW28XC/uL+9Or6HQVo6nLq9PF+/DtFqGp/z64fb+8tPF7Yez68swrK+mMleL9z/CmY2a+gyH5eaRKWHqr7iy84ZUbMJMZ9EBQgelxgdzlBwgxF1ofKzpghOFHJaZMNJVbqC3Mty66lVp8c2rI+l+X3AwRzdiVCWtFWc7P6mWECtpmaf8h7L29E2h8p0oub8x3FKN3afG7lNnN25uR4VyJaQotzwFNil8gQxc4b7S69bJMZB1JZPaITSOzoUdwDtYUStEwTMhOYHfuYjg/+G9A9MFwn2p0eXxUxu8WO8/fYJd+YFs2SIveXzTpy/ZfXe/xCUfyHNc8kVVZPzZ259psY0S121ZsrK836q82mwhqJ4cx7tXTJbrXO0gtIMYx/pNiUGPbBrVaZGdP6XYPq6C7JvgKsLmscdRLRscFvc9mKXqX4oi2FfsCqookL3AZfsSx13fwAqHvuMsNYUwDj2wwqEbX3FgywaHPbzhceShGQ7evfNx7IEVrZCdsyz7zJIHXyfOLmCdBaFb3Hq64KUWkpmrgON7RrNGsNBcmbt61X5eURENncwa4bJpvZECHPigx9c6hAfTGtDJq8HIXQi8cg3MobnxT8G2o8fhaMiEQphozpDosY9hYIiP5OAIXoWNTPB0lqb10PlKbJoWPKB1btug+n5p3XxaMqFgyKMehYvr6pJ6tRuuL/iaVZn+SWy2vzHN1Q1TDzDyhDEqEFFeKpUr6EUf5EhY13iC0jr9Fxg6QIwSHFEl5XlOGCM7sr+f3lzfsMLbdW81Lz+b2wfR5nONpxX/M0hb8T+/zGV1INplnWabXAm93S16RC6r3WBS/KCyLw7YX95YE+GObnmtQHbGYc6/foV0by9McLkfL0wAO18u/K6XC6TjQpzl6d7vvNGMAGM3C7nOIa6MLuDutuBq0Adx+zsIoQ4hQVrigOMlU8w/bNWJvI7AqxXmWJRQ6e2VyDRX4ZthSX1XcJbln72ujAAX71mWJw/XovS/vgcVDnKeCS71Hf+z4gGQpUTC8izjSbB8H2VYjNRMyP66BSelVREhN/UHCIZqtHigMncmXHxtqa/4Xghl7vQj91fiRxku9vFyLxfEudwLiriUaZELqYM3py/03Rr3ApjQQipU7D9xlnLlfwStBgnQuoC84z0dBVQWuSz9r0RfiEMtZJLvhNzc8LJkGz9toMUBr9lf+xVXjyLhi5RLLdYiUDKcFki4Ge3MKxkqjD0dDvQ+T/kZCzy9ToRD3BZcmjZRJbI0cDm2lIT7kUvTvMlBwIPYV0PcVnqTA0vgQIudnxT+6MeDK1DX466/w727vw9HhCsgUuUDqnholc5wXaJrDtWxLhHufst3LODeSJDu8+SB+x9AI6G4P01TxUv/x8xSImGDxUfTs9ko9x/urr2+P9xdox2vOFPJtu4c+W/TQIsDmtGQeljQizqo8BBrWGsCMRrWigFYA0wTgNEAUwzgN6akkJsgpNXhQJ9Wb0zjx3Qx63eZ1w+Xa6sB6J509ZjiZl7rKYCfmEyz/nfYDe9rCbThJIUH5pqbeFnWcBjMoqW8UDxhmqf/4QOnad0hMF1y04gAzqdPmCEvPk0dI0mT4InBpAiaqcbtjtckrJMiWWawEnpLe9ovS/MWIx9PJttcXTDNgrSDEklaLn5kmj+xfV3qmrGdc65MF8UU8SA/YD9LVE2fSe8jg+nMZomhbZCaERX+rD++joxlaP4CMf0m9NZ8EXIl/gLU4nBX1FiXKn9uKHZ/MhSYbTdfFKNRFnggzsEXSiw3VabFR5ZVnBDVyMlLxPdrxdV+pZWQG3hDBeFyvtiXTG9podoe5otstnv5wndwpdmGf+w2w2ACtD3MF9nH16aOsmstTHwuP8goiyIYQFEgfZtl0WfVes3VR8GfghxbTmDWawetoTIPsRMTeNfiIfyB6IRIjplAdIwBTsAs9RzE8SI9CHliiV5MBN06UBC4E8/AA5chlxGVH8Wl8SJ3mc+3mfw4DBBkHpRI0lN5rnjdrGYZuFXuMkLz7/hG5PLyWXNZilye53ItNhWwi+s3R8e0Sh9WYvPx7am5vwtZVLrxC4hnypQeCz6UOSIxLfa6oVdk3BTy7JGndZvvhmuWMs0W8n95Au1Tx3nDRwweLLHEFJ6xZ9k8dwjuDR/xoZV5+9n4g4Q1MMGz57lLL3Z3hEwX8iqrTKt3LzV7DkYzssCThdyc57LUigmpw/dhZEEiu2bBveCpSfC4e/3blstbxB0f2+GjiOfPRb7PY8m2BZ5s7l8se2hDo8ff9dmeeZZ/hlY2RymalTxYk2mToFpHoAynsz0g17R2HMt0tmU4v5ElRvLydH/N5UZvz1mWVBmkO+CywdIrmbbLfoAldWSBI3dbiWAfaVtNI5ZxyJLKXInwHEWnQ1LgkyHkeY/zLU8eymoXBLU6GuWwXQGKOxjQuFF9NqcRmV9qVSWAysBhgmQ3E2OwgUpLPAOv+U8UtfnPDOxL+RgFvpSPFGq7Qyv4cbbVFGLdVe7WEsNH873GlHjasexTtQHG0DNAcvONFDqHjgcN5FhmtzXgngUHNywxlrfb1cNFsnEEbANOmKFjKHLJpYZ+ZAd6LDX6mme6WqlZoqGX2hMTeMe9Gdc5gyZzmbYkRhLLJ1PNyhXw/T6ICTzAt5D0FczzBwEdkLfEWF6xB48hWmIsT5XgqztIkSzFmeZmwT/0yQ0NcNwLnuRpeGSplWEZdTsAN6vgNcbGU3IlWCb+4u1Cy9tKF1Xwlk/ZIaMQ4YrAaLDe261kYUQrxHLKRImdyTWTA0etHSZodpGXkEnXoxJJGm2sm+A499bFUi4lOI36pYxKod7fxwd671sZgSHkBlYsbDWW2LT1w6xGR16GfNzlCJ4LdJjQLhbeK5qrK9T5Ca/TPCqRJKVkfvmc8ALyrbDVaGKugGv1+1oC7T5/4JBra5VI0iOg/qpFL+0fu2zbvVPYA3JuFsbQECcb0M8vWEgBu59GSOB0WyFArE48Aw/4VRibzMGOeKCzbBVpV2uajXI3TJVblkGqF5fRjPy6PXsVrnk8tjNGs0LHspolkhVXKY/5jk+bzhPLUuWPAtJGm7AjRHHP1IbD3s1G+iVZ6O/HM9sVGQfWO30xiQccTrTVWGLzt653UPeRofhJU1wsV1wnW7ONsusqw6rcCTNkDAKcaLcnxbJkf2QgzLPkszBP1aZ+doCLddvNEgVsLMVphORn/Fl8zng3m1hGVOI+W2w0OdOv3tXL6MP0o5ZOi5h4nTBDx/DkSjk1iX6ayjwVQ4StqTkqcaQfuT7NMmAdYonxvKfyfFvJB552IyLDHAzT9AnT2WOJuCF+D+jIwPMAfS2BBr1e+nXV9vest3wUjrXMcDH8xMptCGg05KEz4ySiyhrI6fh6LyescdTXIu8qbPspaYNpaxxzSaTW5k952e7YjfjgOo2Q/DZHB25eyW9Ni+gWNFppq2lE2AYlWz0HMebJTxnOEQd8DHzezC4Db8Aeu9sKH0HbiMa/CF4H5LiAX8+5en3GzyhX3DTSmSouhjVKuDbNcuZdi2MNc6/5YK4UbDE0k60HVpobJY4EXdlGW9LWWUPf0aF+HiqsqnRbISNoc3LWbxesFeIwwbLXOaw5clTiSWpXV1egiaihHksVWqBGYKYtZ4oENgozYYaNQb97Gybqd2+R/g8f68tnrRik0+AwGbH7hCJpUia2iyxvC8CTdNggr6+sN6gAv5a2GkkE5iygpSuAZgqgJQnorO+4rpS842WVhYu/w4ZG/13wLI2D90xw7F/4HlbJHoQ4zrVIuCyB8yeWGMuTwC1WRyWedOwJwJlDGzw9Akpj5ZtNuO3TqCgEYCVmibG8/KEqRtlwp3g9MYUHvr6eGMe74alg5qhxWAkZyLFMUO+J1HPqcgOccabCJdJWI4n5IzwFhSVG8tqUGvOloYj3SIt8vohfKlKz/j1+pMFthYvgtj7EJsufYO/nQE5kAj8bQz2SCmNRCNKkvoe0uo9KJMmcP7BcAC+pL0bzVMRqjIEcy2xqCfj81diCRqbXHy9d00WFgWW0Z1JEjMA4THDsyIRCsyQTGh4dOIkqhydovgQBu1osioFc3R7FeINl6O1C8x20APTVeCLww9STIlmcq4gUEgM5ktkcZw1JptmTolkFV3p/wc2eqQIwijK2QJNB4+S08fHl6pcuWcl7vsk1qG3uNELyn9fAktoJcZxfK141a1+Y5pvgVMdAPgtzJf4KlleHCY7dHWF0tte8WfBzPCwvFITPdv5oxkeJx0c1cbZ4ZHSwZV62+ssTsd9T20tUClmP6RyxnP1+e3ZXN7LiAjnazRFFu885/jWZMJ8xJszNsUzniKXe/xb7sjpM54ilzhstEsx9sUzniaW9ycCujN96jojM/y5yyWHTID7buaKpe43YcHrGtHh+U0Kbf+3jBf1h9G3w9FuZ7SHpBvpaPM3EHPFp6cmxzDVXJoshrCU3kGOZm/oAb/Dqt5EBnlvCd6QO5FjmLmbkfCDHMouMJTFQW4+l1suzTI5KaFkaGJC4wK1DtnoOYjegFkfurEgRwJaYWWIyT8gNeKHOhBk2hjLPKt0ssKz/FqQPDAhc9+jpPduA6xKAE3R89UpFeDm09TQq9FXvq2lE4OjYQI5larU3TYh7xcIJBWw1gVi3uSFnFdpqAjHqY2zrCVToiI4lnoEXtcR72nKGSMJJYAZyAhOUKeWoRJIqqcWOHxbDB3kDPY66enNI1AoowbYaS7x8LupzQoELsEcGM3GhQ82Thvg4MBsmpuywUWB3ssx9SvHIH/ixzLmfZfUmoiK3xEieSbtg0o7BWkEDOZJZ70gGpNY9CLEcc4g9rLHR12JpeQFt2vS1SFr60OaBEc8i/M5a6jmITcs3PHjttkJGwJNKQROEWuIZeNAXxGFDoAu9N10wofgOnD530pAWR1O7xYXQt8HSFW6LyaQhOo5H6DKSvpZC6042jaHaNki6OaVeV4p/fHuu9oXOIbnYnEZkfiSZxowZGJlnRGS1E3ob15lxmFDY4OSSA7mHCUtA0Owaateim+cGrWAn7JA3odu71CVWgKy+dBph+eaATlC/ridFsgoOPqa1r6XToDPdLhsiPYaKp5k1OEk//2XnD1qoQw7migsdDzGOZsFInfYI8EBsOYVp0qYAunA9LYW2FAU04drIAMmtkoSXJXDqxFbjiPdsYw66DKFaGZoBa/MchEhOUkRveHXZIOm8hOdxssRIXv7zCth56klxrA8y5SrbC7mpF4zVn64Q1GVDpa+EDK6WsdVzEE8/50pDF+t4TOeI5TzLS46LxTKdI5aVZtj7YpnOEUu97gIXi2VKjiXy3Zjpvai9nDOZ8AxxExzW80S0rDJ0PH3beaLBltexMTKeu+sg9e4a6Vtl9c6KYKPhIERfw4ozlWzr8fkS2iifMEPGUHJ1uuFR51S4bHD0bhEbbE2Yrf7yROwCZ9tL9HLegPmMMdW1Ny6exhQXy//sMlib9iDEcT59GmQA0vvCBrSKgftvv//7q+9exyCGmcunQM4U6TG40a7BMcm9SzACcvq5rDPkvOdP9vjIiDVQEpByf2clThujGgUBsVz8yDR/Yvv6SbTF2MxV5kr8VWfWsrsD4xBgHmYLsV1wFh2YbTdHOEuVP+9D75JLPi+8v74EhB+tMIkJwDrXdYwbn+Ia5Vyx/Vm1XnNlbx50cCzlLMiPgj/BkEZJQFY6T3JzloH2XmJPNg9saQ6VMyfZmXEXkwIFSB/ZEcJ5Ks8Vr1ensGx6ecs4HJ8dPpwzIZnaN5+GetmmJ4SRlooNFPGjiARK/YjhBvNI52aCyxyOOBihcpIsLRl7wVkEuK8mo+u1GWFmLSPA8jzjTAIL50hMANd1XJeN3ge1hBSgyLSQdrI5L9eh/zfjR52imAD2mgMfs63EI7vjPKxZ4mu+Ycneg/dYBUKBzfgej70wKRZ8gVhCwm0wR5SX/ErWYwheYF9IAB4OJR7NAo2ZQy0ee8F0k1DcgztoCJj2KGLTyLxhhQ9mK8nI8iZPfS9OX0aAtWc/hZ/dQElA7iXbiaR+3U3F428mOdR4dHc0aTPW0KXN8NDdBvQAXCt+J+GTi3xjwO6t1GOmZ990NM5fgA8aIqae2RVycyPSNONPTAWhYwtCCOGagV4lXD4nWeW/mY0Cj7iqMyX73oVWQUCY87+y/VUlk0ATd6DEI9tZfwByoCQg68bMGfM1Mw8aKuY923FfFdJTUVF3PMmVr+vVl1Fhpb0GcoJVOpY+RqNCDdRZGqe9zJM+1FE1C8pM54TaSC45Dd6OSoZbFGMxFdxu1wSSLTUevTh9f9ptuufpjdiFBqLcBoQApOYbrmDFeSwmgJcfuSr99epBQ8A0ae99kEZBQJj1kE2GOHM8xHgb4BjptiCEcOh82zlLxmRLiAf+wn1f+1844Uv/C9/7RvDNzwTnMn/qDwv5XvSRFo+9FpIvcx+sVVAQw2PZHQznYewxkDr/OqBFZAvnAp6mqWjyu9o7xQN424wUzDV/5NnCV50cRRSQ3MBq5IGSgjSZ50FPti+kAJ+4SqyFsQ5Wq8FjblgRmFhoFSTEfW5lu5hIWexC+ywJITWZ9sPrAGzhTMBQoR2LKeAmpYfppniRRxkddu/toPVUBNTl/U+3FysfplEQEJAxjzmGOcJLRMhLQ97zZw2ovPoyAsw/NvWeNCxlrAN9gE6Ch9zuvD1k8zPBuQTNgfZlFBhw5tMWEoAmuX8hrurj4Hy8vs6Js50OdzW4HDo3M8TEPkoT7+ONxHjwYRT6Ok9C1znSzoAdrhmfhjpXi4+e11Gu996KzRaSrqTkaaDiOYqIoHDLpS8jwcwCFj/HKAgI4Z2yMD8TnLdzOv7ecE9FQoUWBdHX//xacbU/FFn/MPRIi8feMbnxlev6d4J7K0Wra4X1mDhhMlcQw0zAgQCc2X9J8OBA0ZQJLYhcZr43pZNQIJ/9a7waARWw2sskCDEiCigwZUKdLGlToPpLYSOhQJpVxt1KGZYlVRZqAUwbkQOZOO12KgTfKbeRcKG4/2k2EgqkGUfwQhoJHRI1zPESIxwxR0X5A4KcDhUXWD011JXejywTabjETxlRAukSZQa6k7aQBKyUDMNaEQX0KB4DFVetwCPsfImBaxqLCeBeWrUQdiAlQ4PvjaUj4NKHurj5SK1klnWUTYqx8HSjpSNcnpXLK/QQR2IKuM3gBZmhGYtJ4EeR8GYjwlp4X82RloDd5krDhpyHUgJ0Ov/FmBrIexGNNQ3kvck1473WgZQCNYMhF1aGbQeuExFAWgnolNdIS8WK9T68e24oJUD3MgG01foyPOyebbyzlfXvJPe+8m9+JjgXO15qtoPMSo60M2BhxdElJ8Dzn1fh73BPRUFZOdQckHHitCj3zSsDuRpLSUD6P7W0j6uxTutNjwFEI8KDPsjAEEYjoAICQxhHEQF0t/AR7hYE112yCR+g08yAsc9gmkY5zl2KwVUihdU6AyUeWadPqhOC9obhH9ucqBayp7RxbyIWuwcYju3gMd6HCRamGa4UC0DSVZYz/erdoCpwovpSFGu0gMOJca7eABKGKTacAFd6DaB/2MGeTir8XM/IWIZZXrx0V1oZFM91bCSAPHVqJCoGT5YZQCiBJDOUiBA3xnNiJDiS8OD0RCCwAWpwHOEhw4k4YMOGwDg025Rne3sllZN7FKI4VpYuJ2CUpAvoeSqPkxPiSxyF4sW+XVEpnCgRDTM4waNxJXACRvIp6fI9H8HrtndmgY9Cm/Pu7UtxhrvToaSUl1rl+xCnlX0JBvZK1sJq8LkZtQjn/8mUm5D/WkTw/wgCPKIILE0D3lmavpxn5HOF+X6N9b2QYe8LifU+3sEwxXBvZHhJEv55IFjo54NgvcGyzIF/mdU3mWJ1ShypKLhMh4sV3aieFMeq9NbMSiQsWHf1pUNWz6M9kuP0NB7LAUabZLkMhVlrcN6bDB8h/40KSWiypvDTQgQxR6nnbvdkBdxj4fcIalrQWjBJndnkNBMs9Db1lARSOyFl9S88uKOcwLSXrnpo4+WrURx7oM7DGY/UATkptzPVORmN6KX9I79KMQTct6gxDjYXOhmSAWkoU9riUQT0s4hh4J4Gt3Z7OAF8tONjXt/IuwP1/qL3BdlGMqYXoKfbU+JIwUYGR7YxQJ6xz9aMww9ykLgRByGWo4JPwGhw3p/r3MYmv6+9TsLNsdWelsdaZDrY4m1EqLghAwD4/v863O5dY9u964zZOZPc7hsVklCV29HUywTmKMWxcnXJkm0I06hQBGtGzOl9NBM2p2dk7QDzjav3N1yDOpQHHY0CqeNsMY0HZqE5wYZdrcF6v2HP3fAE4FL6ahRxG+x1bZG9LZBn5PsB8417P7asBL0fBx2WEixHtQbn3ZU0y82YSpwVT2oWgAcfzMgAxRVSmK2RouTHKaMQ2mnjaYUI2U51DnI8Tzjvi5HXtBJyk3GdSxjRliOZ94rJ0izghzFtOY45OtTHzXIe4gNkZG2teJ5XMvQttbQkWqgEZqS6ehds9+2QbT5pLf91upajZb/z+kZ+CaDecd+CfL0OOM/Xa5znUOWPHG8E+EXeaYhn5F0GeMaNQuTOZBwTjKmEHGBWEqo9jeQlfaOfLMw79unCvGOfsDsDygRnOgsKkFewKjgvVGte1jvySRci+IU3kpf0jY1ccTO/CZzjHai/PPHfcZXI95PGxL21rZdbmfA4bt/i30emPV0im/SUiWzc01bsCTqk0ZfiWJyFxl6N5CV9I0uH4mkV/FI2IqT/Xf7IT7MM/CxGBgQuaEilLyWwgAXcFn9pHrqU4Im4moNCRNYXzcbPIKpWYQnVDgCohmu85/ePLgf2wVQThPFhWPP7x15BJRfytNzLBDLwNFCjiGVwVqVEzgWBPCPvE8w37t0ueXdE6/iEtynUwADLhQO/PAn/pECfuZI0s1ZCZ7pK2kyXMQdPI9hiLC84I1KiZ9bKqJm1coaZtZLrJmNMmNXosBSzBz+vAJVEK8Rx8uD3zEhQvvVW5U8B57XmZb0j33qd/7wKuc9/XqF9374HeL99/9L+CXcHSsB9w2IIuPaoblM0BBmN7Esw0E8jjoJ9InGUL/JUvn77RSjfoSiVBIyeNqKX9o8sWZUst2Id+gi1KhyhSJnmppXRzzcXAjqNUPynLQ81T4wE7ftU7k9lwsvwxPhAPQdxEWoRjfRzUM1yr9CImstkDvY922xi4Y0Nmt72nADMVokmQW8s7W6+zyMK7FE8Aw9UXPvyGZjge5rPU1aPfsBFdWhCYC+Z4sGFM30pmQV8pp2YzIM/z56eTI14ln0DNBf8HIlPMeIZkp9g3POb4+lFPrtZnhyYRuGo4JIyI3lJ38j2JiTFAj7DAtj7S0eP7IGBEkQQ8kPU2dDsU612eVoNcqoYz39jPWnDePvq+7dvvgWCTPKwURLFSZZR5wd1PK7LsQQmqtYgHvpHD9udmnjkcVntym+6v9vP6B/9+1MIa7t3jePlN83fbbtXrweWgzTUPVtH9umR9TXbfU7ZFP3wa8BLu2ja6aP9LeihSQM14aL50e+jGPYljx4KV4/Rtj9jpUjMprax/eEnkP3VYNfbyMuVY8eb7cuVfalzM5VbyfZQP3pz1LFKeKFd5WOo8Hm7zjdXLNF5fw9i5+f4m8/D8Qi+5uBnl6exxuexPZts6plbP/v8LJWQiSj6Gwk7H4effPZt8T6rRJa6npf9u8+TySru8tD8PWzZHBg7dUPGGp/Hhask17XmmiW8/GYxVZBff/du6CZXJkP7tJvmd6+bC1F/+Fi/2PTdHH/3ummu3u2i+c1n/nOZyyXT/Y2OTU7Tww8D69GRa+ZdcZ65d/gh5IG584wwb04RVr8HoxrFMp+qVoaOFhuZK2ej5/AjxEEwnqHM79Rx9qDlbeLcwaGb0WfMcuL8kI1dDL9jAx+uL9nQSXegwoST7mePk8956rQ2f/eYmRww1cROz+43v3n7uM79jgYqkMvpT5rLtf/zNoF4n9sNAJfjRgNyt1S5WecXuAmdCuTyLs94eZpl+ZO7U+lWelxfXF5f3l+6XDW/eEw54IEMNR53P17euzz8eHnvMdpOrtTYOtdm9Ezl5MOWoUe8PL0//8llWf/gMTQG9XmDLuPDjz7y7cp5l8zffdxxI6fHdTdzBg6mi3IRLsDLD+6oP/iC/vNwOqPL9virx4ViT2cTNWH7k894+muggp8C5fkOqPBHQAXecwV7u7WYGF2rfxgZ/vH/6Zbr3g==" \ No newline at end of file +window.navigationData = "eJzFnW1v5DaSx7/KwXsvs5fMQ2Y3weEAP03SG3vccXsmFyyCAS3R3TyrJYVi2+4c9rsfqIdukaLIYhUn92ow7n/Vr0RJFB+L//zfE8Vf1Mn3J/8pSsVlyYr/OvnqpGZqc/L9ybbKdwVvvv48/Pb5PzZqW5x8dfIoyvzk+9dfnWQbUeSSlyff//Pg6rQQrPF6aRWmr7dfnWQFa5qT709Uk/9VNH/lL538xE1ZMtnwHIj5Sz2oe9qr796++cbD/Ndv//rqgLqost2Wl8oLG0SJL6sFPLBsBtbJrdvy7TvghV0+8VJdboVSXHovbiwkXuDY1WmzL7Nb3lQ7mfFjAK1DTwCzLszQXr3+u6ccjqVwel9Jxe4LHip1I4iDVUzhu4veuIabWomqbKJiCTmjh3jLH7jkZSbK9cxNiwxzziEu1A9Vzlvvd0yuuYqKyrKll1Xcm/QXrv/CD6aYCmqVsYL5uZ2E+O6eXd2c//T5/c3VxeXFkab2tZM1Vlul+s13f3v17WtQyXZerhZ3l7enV1BoL8dTl1eniw9hWivDU37+eHN3+fni5uPZ1WUYNlZTmavFhx/gzE5NvYf2c/PEpNAVaNyz84b02ISZzkcHCLWeGh/M8eQAIe6Hxseaf3CikPYzE0a6nhtoUYabd6MqLb59dyTd7WsO5qhOjKqkleRs6ye1EmIlXVY5/75pPX1dy2orGu5vjfdUbfe5s/s82E3b+1GhvBelaDY8B7ZpfIFYrnBf6YfeyTGQh12ZtQ6hcQwuzADewR61WtS8ECUn8AcXEfzfvCUw/0C4LzX6efzcBy8e9p8/w678QDZskZc8LfT5S3aX7p9xyQdyiku+2NUFf/F2qHpsp8T1m5asae42stqtNxDUSI7j3UlWNg+V3EJoBzGO9YsUVpdwHjVokb1PKdk+roIcm+Aqwu62x1ENGxwW9z1IUvUvRR3srA4PqqiR3dBl/xLHXZ9lhUPfcpbrhzAObVnh0J2vOLBhg8Me3vA4sm2Ggw/vfBzbsqI9ZOesKO5Z9ujrxJkP2GBB6Bb3ni54o0TJ9FXA8SOjpBEsFJe6VN/3n1dURLaTpBEuu9YbKUDLBz2+3iE8mN6ATl5ZQ4ch8Mo1Mojmxt8F044eh6MhEwphpjlDosfeBssQH8nBEbwKm5jg6SzP27H7lVh3LXhA69y0QfX98rb5tGRCwpBHPQoX19Ul9WrXXF3wB7Yr1I9ivfmFKS6vmXyEkWeMUYGI5lLKSkIv+iBHwobGE5Q26JG4aZfEj3N3S77ISAViUOKIaiiPz4wxst/86+n11TWrvSMFvebLz16PQbT5a+1pxX8P0lb89z/nsgYQ7bJOi3UlhdpsFyMiL3dbaxHAQWVeHLB7vjYm/h2jAK0C2feHOf/rK6R7cyGGy/10IQbY+XLhd71cIB3X4qzK937nnWYCmLpZlA8VxJXWBdzd1FxaXR63v4MQ6hASpCEOOF4yyfyjZIPI6wi8OiPFIoyd2rwXheIyXBiG1HcFZ0V173WlBbh4z4oqe7wSjf/1PahwkPNC8FLd8t93PAAylEhYVRQ8Cz7fRxkWUyomyvEyCSelVxEh1+0HCIbqtHig1CUTfnxNqe/xvRBSl/QT91fiRxku9unyNhfEubwNirgs87oSpQoWzljoKxr3epvQwjFU7D9ylnPpvwW9BglQqoa84yMdBdTUVdn4X4mxEIdalFm1FeX6mjcNW/tplhYHvGJ/7FdcPomML3JeKvEgAk+G0wIJ14Or1a4MPYwjHQ6k16qdscDdG0Q4xE3NS90m2okiD1yOKSXhfuClbt5UIOBB7KshbnZqXQGfQEuLnQ4V/uinYzlQ19ORBod79/ACHBGugEiVD6jioVU69jJI15StYxkk3P2Gb1nAvZYg3VfZI/ffgE5CcX+a55I3/o+ZoUTCrLVO85PnKPcfb6+8vj/eXqEdrziT2abtHPmLydLigHo0pB2F9KIOKjzEGNaaQUyGtWIAxgDTDGAywBQD+IXJUpTrIKTX4UCfV29040d3Mdt3mbc3lyujAeie4/WY4iZ62xmHH1mZF+PvsBs+1hJo9pyIB+aaCvmyLHsYzKDlvJY8Y4rn/5Ye/Bp5mXnedj/0AIBusgAXC8yYoWNwjFvNgmeGriJo+qNhdvNmYYMUydJDo9AiHWn/XJr3ofXxymxTyQumWJB2UCJJy8UPTPFntm+fum4k6ZxL3SHSL1SQH7BPElXXQ1P7yGAGsyQx9M1fPX7DX9Sn15Gx2OZfIKZfhNro708lxR+AbwbcFTXWpaxeOorZew0FZtqli2IypgMPxDnUQ4nlelco8YkVO06IauLkS8T3847L/UpJUa7hzSKEy3SxL5na0EI1PaSLLFlZfuESXCm25p+GnT6YAE0P6SL79FrXUWathYnP5QcZZV0HA6hrpG+95vts9/DA5SfBn4McU05gtgsjjYE5D3EQE3hX4jH8gRiESI6ernSMOM7ADHUK4nQFIoQ8s/4wJoJhkSsIPIgT8MDPkMuIyo/i0niRe/jTbdU/DjoEmQclkvTcnEveNqtZAW6Vu4zQ/Fu+FlV5+aJ42YiqPK/KB7HeAbu4fnN0TKv8cSXWn96e6vJdlPVOdX4B8cyZ0mPBh5IiEt1ibxt6dcH1Q1488bxt811zxXKm2KL8H55B+9Rx3vARgwdLDDGFp+1ZkaaE4N7wER9amTf32h8kLMsEz05TSl+sdESZL8r3xU63evelYi/BaCYWeLIo1+dV2SjJRKnC5TCxIJFdc+5e8NyUe1xZ/7Lh5Q2ixKd2+Cji+anId1Us2bTAk3X5xbJtGxo9vtST3fOiuodWNkcpmpU9GlN3s6BWR6DYk+cekGsSPY6lO9tlOHuUIUbyqnx/xcu12pyzItsVkO6AywZL35V5v8gI+KROLHDkYZ8U7CNtqmnEJg7ZUJkrEZ6jGHRICnwyhDzvcb7h2WOz2wZBvY5GOWyOgOIOBjRuVJ/NaUTmN0ruMkBl4DBBsruJMdhApSFOwOv+E0Xt/pOAfVk+RYEvyycKtd8PFvw4m2oKse0qDyuX4aP5XmNKPEtZqSqrgkscTDV5cYWxB+FUroEFMDJAXnSV8yzI0iL6JVbrUqgKOu5lybGXN2y4uGPBQRxDjOVtt+2wWNk5ArZ1Z8zQMdRVyUsFbUxYeiy1/8DcF3zFZc6hlfWMHTqK2JJPVOalYpmCFvhITOAd991cVQyaF2jekhhJLJ9M1euEwOV9EBN4oIeZ8uxWjwI6/WGIsbx6Dx6xNcRYnmzAV3eQIlmSM8X1Zg7onbMNcNwLnlV5eByvl2EZbasLN4fjNcbG03ApWCH+4P0i2pudqnfBIp+zw0ahmCh4vuRcRvQ5Z8yQMYhwZaQ1WO/9VsUwohdiOU0mxVanTqqA8xQOEzS7rhrINPtRiSRNNm7OcJx7N2MplyX4WILLMupIgvE+UVDd08sIDFGuYY+FqcYSu95dmNXpyN2UwdEZZxJSmmM17RIj5psdJjQ2vOedqrs9+AmvBT4qkSQpy+ryJeM15AtpqtHESgJ3n4y1BNpd9cgh19YrkaQnQI3Zir60f+zWAPfedw/Iuf0dQ0OcTUI/gWRRClh5aiGBM2y3AbEGcQIe8Ds0NUnBjrihSbYjpaKT3p1u6+k1k82GFZDqzWWUkN/2It6Haz6PbcJoVuhYVkkiaUfQYtoR86ZpYlnK6klAWqUzdoQoIo4zIp9eFM1Cv4MvbFsXHFjvjcUkHnAo2VRjid3fhv5QOzIBxc+a4mJ5z1W20RuThwEKWKU7Y4aMQYAzZY+kWFY5Ho8J8wx5EuapXLf3DnCxbrskUcBGsJxGSH7BX8R9wYcZ8yaiEvfZYqOpmHr1rt0qEqYftXRaxOKCGTN0DM+uJG6z6Oe5XG4xRNi6saMSRwLv1iFu1PmBq9OiANZVhhjPe27ON7vykefDWJOdPWWePmOaPJaIAvF7QEcGnuUZawk06PXSr6u1v2OjpdhwrGGGi+FH1mxCQK0hD0pqJxFVoyWn49t90bBG2FiLLFXYVm7SZu3eOOaSSK3aH6um3/0e8WF3GiH5fXYd3Kyh35oW0Q1oVNZU04iwzX6mOgUx5s7PGaaIAz7WnzYnk+UNODLgtsJH0DfW8S+C1wE5LuDXM1XvUvuZZHmcRzqTPMawJqkS51nOjIlxLDtrog/mSp4YQ9PprmBPc6fEkaCrJ2nLJgdr6Dtq69NQYVWl2woZQZ9Nt327YK0QhwmW/VDBmiNHJZ4kt211BZpws/VYqlACNdIzb5koEthoz4wZNgb17m2YqN69Rfo/fKwvX5RkkE6Dw2TCHhPqrEt22i+hvakBd9Jhg7y+pt3sBfxammokEZj/g5b6A5p1g5ZwY7C+5Wony1ve7Irw4++wodF/FbzI4+AjExz7J76HVbIHIY5zJTJeNsB5GkOM5ZXA7YpHJZ507AnAmbYNnh4BJbIaZeetnkMNSvJQy1W1XocbXJ0KeVmtLbDmNMRYXvW4qyfJs+d4IzGFB76+kRjHu2Y17Ck5CMkPyTXPBbvb18D6xZIjLxPWSyT1EId8IrC1l6YaSaye4GlrDDGS16fhSZe6Jt4jLfJ0EX+pSPUujvgRFbcVNgK5bXsKOaxmsPU46k17uFdRPcNqBUtOZAI/yrYeSYWxKIRSHwkC6dMclUiSPpdluQBe0liM5smINTWWnMiEvQ6WnPy5HKpG+OTk1AJ74amq+S9dvUeFgWX0RwVFDK85THDsyMxrSbKu2Se6zqIa+xzlL0HALjmMYiC3aEQx3mAZarNQfAt9AMZqPBH4XRxJkay4fY9J9jsuZZXxpgHkKDkq0aStaDgkv/FIimbVXKr9BdebGmvAYNzUAk0GTbfQplm67N2ge9bqkJTVT0OWqg98XSlQB8tphOS/PADfvEGI4/y847tuoRZTfB2cl7PkSZgr8UfwrXCY4NjDSXlne8W71WnHM1lDQfhs00czPEmUqAYftOhgaxJN9Z9PxLYPTC9RucM9piliOfv15uy2bTTGBXK0SxFFn3Ih/jWZMU8YE6ZwDNMUsbSbUmNfVodpiljaFdAiw5SLYZomlr6QgV0zv3WKiPT/LqqSw+bsfLapoml7wdhwRsa0eH6RQul/zVNs/WGMbfD0m7LYQ7KOjLV4mo454tMykmOZD1zq9LWwlpwlxzL1CQcRSzUnBnhuA98mbsmxzG3M9IclxzLrgmUxUFOPpbZrCXVyYuizZBmQuMD9dKY6BXEYIIwjD1akCMAP8lj95xPxrd7WC2zVpyEm80S5Bq+dmzHDxtBUxU51a57bvwXplgGB6x7zvmNr8G0HOEHH1y4ehr9tpp5GhVZoYzWNCBzTtORYppJ73VC6kyycy8RUE4htzwJyFK+pJhCjmhymnkCFjlsZ4gS8qF0X85YJIgnnn7LkBCYoSdNRiSTtSiW2/LA/Jciz9Djq6s0hDzngCTbVWOLlS90egw3cEzExSMSFDtvPGuLjwOxhmrPDRoHdXDZvmSgS8G1JucVs9SaiIjfESJ7OuKJzLMJaQZYcyWyTEQAyqh+EWI5e/gFrbIy1WFpVQ5s2Yy2Slj/2KaDEiwi/s4Y6BbFr+YaH6N1WyAh4tpPQjMyGOAEP+oI4bAh0ofa6CyYk34Lzlc8a0uLoare4EMY2WLrM+XD8LqD0x2o0EbfPbNYQHccTdLnRWEuhDUeFx1BNGyR9w2o+SugdrlZsA/Iiv9bjKi6AVUK8WJdM7ST/9PZc7mtVQVJvOo2Qd+DoKpJMY8YMRqUZhVpthdrEdSAdJhQ2OJewJac/ZO3myX53jL5v0I/ajB2yEIYtnEN+GcgyaacRlq/P/Ab1pUdSJKvm4JPfx1o6DbqGwmVDpMdQ8TS9uisbpzse/EEf6pCDVHGh4yHG0S1FarPMAW6IKacwdfYowAd0pKXQlqKG5recGKC5u0x/+2C7ESw5vRLfZXotLHBO0FTjLviOrfXR3SFUL0MzYI3OgxDJyerotAMuGyS9nTgETl0bYiSv+scK2F8eSZEsPWXSwN6JsZb8Qnwscy6LvSjX7RLM9pMdCsBlg7vso6eVKIPrz0x1CuLpfSUVdPmbxzRFLOdF1XBcLIZpilhWimHLxTBNEUu7kgkXi2FKjiXy3Uj0XrRezlmZ8QJRCA7rNBEtdwU6nrFtmmiwz+vUGBnP7VWQenuF9C2Ldu9VsLVyEKKvYcWZzDbtXFAD7YzMmCFjaLg8XfOo45hcNjj6sCwUtsrSVP/5ROziKdNL9AL5gHnCmNraGxdPZ4qL5b+3BawxfRDiOJ/bFkQ7FlgcUWpfm5SxzAJ9893fXn37Ggazks1NMa7sctGA2QNyZnj+o3mi8fZJIDNU54kjMbDJ/ukpyL1fOgLy79d8e8+l3SWYksY6Ai4MSoS45Q9hyi1/wINO75s2h94H/mwOHU5olpKALPe3RmrVKapTEBDLxQ9M8We2bx/ivqbTSycqqWdRJl3VaQgwD8lC7Ne/Rgdm2qUIp9tOG6gCXfK08PFyNxB+suAtJgC59tVQ+meKc8n2Z7uHBy7NfeEOjqFMgvwk+DMMqZUE5E5VWaVPVVLeSxzJ0sCW+kBffYqwHhPUycOA9IkdIZzn5lzydrEcK+ZX203D8dnhwzkT6wueiS0rgh8qW0qCLkrF14DPsC2lQEsm9137oV0v76VaWio28DIfRSRQ7kfY+VginetZbn0EtzVO7CQZWjL2grMI8FhNRreL4sLMVkaAFdV9+FU4iFKAfN+wkYqAqqqCsxL4wk3EZHC4PMc6Aq79IA6HG/l4hpACFIUSpZm72Mt16P+f8ZNBlpgA9ooDnypTiUcOp9AZq22u+Jplew/eYxUIBTbHdDytTSd18gViCAnFUG3rquHvy3ZM0gscCwlAyZniOotleORjosVjL5jqzqfx4A4aAqbrKLY9kmtW+2Cmkoxsrqvc9+KMZQRYf2Rp+N5ZSjoyWPmbQgJwX7KtyNr6Rdd0/ka8Q41HX5Z5XYlhHfWQr8tDdxvQA3Btj5mFz+6IiQG7s6tMmZ5UKtE4/xtz0BAx7ZoYUa6vRZ4X/JnJIHRqQQghXBXR66DLl6zY+QuzU+AR79uTPnzvQq8gIPQ5ucV+WNfvQ5lKPLJfLwVAWkoCsm09nTFfu/agoWI+sC33VSEjFRV1y7NK+rrLYxkV1piL12dYjWPNejQq1CJO0hoeZRT3oY6qJCg9Hx1qlLnkNPgVu+fFmVDXrPF9aWwpDbpk+6JiOQxrimngn3dc7rsFBzD41IAWwFzWEyfcm2YlGtzlddCfcNilOyzShAC9eEONRy9OP5wOmZd4fi22oYFxtwEhgJxv60rxMusyBISLf8YiQQgqAq7o2G5kG1Z1T8UE8PITl42/DXHQEDDdEWU+SKcgIPSmjS7hsz7Kb5ofYop0WxBCOIxsmSn7pmRDiAf+xH0t2584oVX7E9/75lL1zwTnZfU8HuL1VXETLR57JUq+rHywXkFBdOttvIxOQoC0x1YBWv+mMBXwNM9Fd1yDmUIogDfNSMFc8SdeLHzVyVFEAZVrWI1sKSlIfWAX6M6OhRTgM5eZsX3Gweo1eMw1qwMTn72ChLirjDRoMyeQuNA+S0JIsAVmEevLoAeotaeUhRfRmULKhY78hF6WqZgC7nLM6aEAL/Ioo8PuvIMgIxUBdXn3483FyofpFAQEZFwxxVBieJEgeXHgB/6iAJXmWEaA+cd/P5CGfrV1oNc1SCiQcrVhkufdRLSXZSiT1E4fdludSjxYLRo6/MXebL1DbvpngvMStBBmLKPAgMtfTCEBqM9jq8X79nx0H2+sc+JMp/YGU5dD577SmNgnR2v5eBMxHnyY1rqqstB1TrQJsPYuunmoc//c5H4d5WrvrcVNIelKGp4HatmjiAgKNw/HMhJMr9f0c7SCjABd0UhIAArvpKv+meC8n5X2j3GMVCRUaNEtcH0t7At4HCvXr4t/Tm2ixV/mLSvXvneq/Z3g3jiCwrXfbUqcMUkVhH3SSSAA5+kmJHhwJHDOhBZEVRa+l2aQUCD3/kXGnYAKWO3LLAjRIgooMP9Lnfntj3jwP4WdhALpNvQM6wxZke2KUOtj3ogcyHDM9E75p2ldchpcSO6/m52EAukGiryQTkKHRI1jfYkhrJijff0BQU7zjQusm3Ttn95PrBB5+ImfM6IEMqTID/TbTSEJuJNlGNaLKKAn8RSouFoFHmFmSg9c01RMAIdGHxIOx46TN4cu0ZJSLzD8jho6Ks6/8xi68TimVLtUTUFoJ6NeXufFzl3gRTrzF8SA88e2yvDhekmaUm0TRIfXBBg6wuUZmZhDL8dETAGXTbePM7jMw5ZSoENCXsBg9VRMAj+JjHebRR+Et06faAlYnYU4MDVz0CTANDXzjnyZQgqwkgo22WVLCVChdyCHv1sjGQE2n4RwSgwkH4zG6u7pXucb9RasJaVA9TDohXGylQM3iAigLoWqrqvDt9HWUrF61QmQepRSodesBjIPSiryMHUABFt6Kh5ITQlb5MEWwlSdCq2fFTBZi1OB/XtTJtpUWMjs1YxFqhC6Gh7M7+TJ4G26YDi8lZPhwE/fREwGz+VSnmN7kylH4fVwsM7/CskH4FCT0AK67m2ipWLFwz6czMiWUqGQ8j3ICLB9mQEGD8cyPOyOrb3rI9vfSe59TUL9M8G52PJGsW2td1br/wRv0IxFihC6/c8REYwNEgRwWVfZZsWzqswn2avno5haJQgF0GmdaBNgYVWRS54CrlT7UMGL3rRIEEI4S4stJUCrf6zCY4YjFQVlnHDigEyPNYly39XakKsxlASkHvE7E+qTdaTFlGgICUD/eBlthExb522itwCiE+FBH8vAXHInoAICc8lHEQUkwl+Ko4gAul34CLcLgush2bMPMGgSYJZM+F4VQ0fA7UQO+45YSjzSmXz4qT+NzkDO5h9+AyNZaTedDEeuzRjvdt7feYYr9S+Q9L6omHr1zqpznKixFMWa7I1wYpwbI4AEe5rICXBNDwH9DyuH2hNCZpdcOak+U1IsdpZ1L92V1h3FO/v15sxe6QUgH80SxODJ8g4IJZDknRIRomAMS2Qk4eVIM4HAliSB4wgvEpmJA7ZQBBiHYuvmbG/OhDm5RyGKY5yS4QRMDskAep47R8EJ8R3cgOLFvl1RRyhQIrJPUIBH4zpAARhJ214wt1Rtq3xnUbXnv7CRtGO8ffXd2zffvIWB9Od10oGaZWl1dVDH44ZaCEyUvUE89LcRdtgqfOTxcrdtvh7+bt6jv4/Lpxan9WgaosXx5uvu76bdq9eWpTVpM7J1TNBMrK/Y9j5nc/TDrwEvfXXr9NH/FvTQVZQzLrof/T5q+xSao4faddiMaX/GGpHpDPtT+8NPIPv3ojBe5YmXTuDz5aqfBjdztY/pob31Or+H1Ifqup4PW+HzdlWtJ/nPBj/H33wejvs/uzwvLk9Tjc9jv1ds7p4bP/v8LKUoM1GPO1eDj8NPPvv+8Z5kahycmL/7PHXnjE89dH8PW3ZZEuYKZKrxeVy4nuS21uwO11nMPcivv31nu+mOrJh30/3udXMh2kFgNn5sxm6Ov3vddFfvdtH95jP/R1OVS6ayUQ3R9foPPzg7+dZ75NwDefgh5IHV4mj70I+NN1+zWpiW796aRq4axTCfq1ZsR4t1WY13ehtOuh8hDoLx2DK/U8dsuuFtZu7cdjP5jBlOnB+yqQv7O2b5cH3JbCfDAsUZJ8PPHif3Ve601n/3mGVV2eyMlIlH0+E3v3l/u879jiwVyOX8J83l2v95m0F8qMwGgMtxpwG5W8oq32WhQhhUIJe3VcGb06Konsdzvy63Y6XH9cXl1eXdpctV94vHlANuiK3xuPvh8s7l4YfLO4/RxhqVONptHKMOhmk5e7PL0C1ent6d/+iybH/wGGoDK9P50fjwo498s3KWkv67jztt5Iy47maO5WD+Ua7DD/Dyozvqj76gfz/sWHXZHn/1uJDs+WymJux/8hnPfw1k8FMgPd8BGf4IyMB7LmFvtxJbt337w8Twt/8DaDrVPg==" \ No newline at end of file diff --git a/docs/assets/search.js b/docs/assets/search.js index 0d9c7bb3..12227264 100644 --- a/docs/assets/search.js +++ b/docs/assets/search.js @@ -1 +1 @@ -window.searchData = "eJy9XV2z20aO/StbyusdDwF+u7a2KnE8s97KTFxxZvfhVipFS/Q1M7qilqTseFP571tskiIajaZASZMnJ1fdANh9gEbjdJO/bZr6c7t5+fjb5p/VYbd5iQ+bQ/Fcbl5u/r06dGVzKPb/sXnYnJr95uXmud6d9mX755+nn35+8bF73m8eNtt90bZlu3m52fz+MMkCzM7Svj5W39S7L2dRYwcqamwiiHzYHIumPHS2VbOiGGazt/Wh7ZrTtqsbrbKv7D6XFE996ZMGGM0W9P31usfWN2utD1156H78cizXPHffpxv63GrBrmy3TXXsqvqgtsDuc6sF5a/F83Gvf/65/a2auzXDfsN4ux715vChVmjum/2hnnVWeKV3mee60cOIDY6Xde3uT1X7p+rwsWyqrtzdYM0qz7PGRfS++1m2ziNny3xeeT/L9J46WyV56/0sUnrwbM595w2DaHbt57J5Ktc69lemVzX0utbL7Pjy/bFsCgV6zu3+sAhja7wixMyPdrPvMFvWL2kXbTH/rDJi7HEX7U35v6ey7dYZMHe6kw3tsT70YlZaMXe72g6PTyj802r7x/vGLUuw/Zj385F7LjIqG9f4zmyc4z93tmqlT82GSX51d9tW+hq1TvK32+2zVsensvu+edWURVf+cO0wPpVd3WyNjCsj1T3Wb8GwtYu43p4frp9W0//qWLqcY7wtmuL5gkmmzR8WP2dtV8TN4XFu2LdQ7TdsWpbtUO9Y7LG4cbuyaJN+LSE23b6GLNqk26UQe27bolyw5bivd6tsmTrcjNs+RFaNMV2pnPS4WXvbfVkzB1Pzm/UqdoRE7T39gkbIU/fxL9W+K5uL64nV8g+Klq7O1THTfsBrszjBEPUeSGVBW25PTdV9ebf9WD5fXtwFeyYJrZGgXuO91hGUvKoPXVPv95dRYrf8Y1Ai6FyLEvaAnjkqjtW3umVEMqk4Viv37mqr3jwd6mYRwB6Dqqnj/Wz5+wVX8lii9Sa1HWPufgVge3PGrF3rRTqrjJhXN4C6b/YvQXYv9PS8nLv73GzsdydLysPuWFeHbrUptOO9bGmaunnTd9qWxyvmy/SvrP53suzSeiVZc18PO9T9yrHahroYet3JimOx3oaxz70saOrdabvec0i/O1nS1Puy/Xq/rz8vZ9KSNaZvce57vUUXKinXRGO3lnJ7VCa5zesxblwyjbb7Y/IaR+ParMZ6tFuyB9eSVbmD0g516Vs0p556a9GhsUqzLsrTpF0VlVaMOF5tx9zvLpasWRFde65ZDzVWfey649/K7mO9GPdce/p+z1O/u1jyfIUV/woLLiXhPiu0OYLGkks5imvDXbVfzE8E/ersRGPBsS+7lF3ZvP61a4o+Zq8MI2cBJRVwJ9vWjo02a1JpV+RMggUrMiaNFdp8ybVkbbbksQYThOiaPau4/q3MjZQ2nbqP5aGrtmZl/bZqi/f7taNly9jNMu5k47Txe33b2jT+5Y5rFLPzw2m/f7va7/peN/oes2MEyisdSSOgf+i/8nCn1raBBLzBuEHAv8a63u+vCBW3WMD2U/OW5m1TH79vvi0/FKf9IkPtGvVUdnNqeGzqY93sznLuZem081tzpkU0ddr83TPHJ/u/74/l4etj9dfy0MteDhu87R+zDxS1rt0LOo/pmbn3p2q/Gxu/O5bb9YYZCfWxPBTHqh0k3M268tdj3XQ3mTeIuKN9cXI2781bJ+c7G2iEfSi2to1CjytAxXfSRqjlbOu09/mEyT61fiY9uGZbsNIs7QZhhTltfWq2Vxt07n2jSQzkpsG1Ns3d72lUW3bf1U9P5bWA/qotu/0k4GbD8hRi5CH8L3XzXMzD1q/9UjwYml3hZVzt2cZ3NoYcxazhFaoTMSWfVX44Hbb9umippS1v07mtDx+qp1PTL+bLOmnLu+k8qnUeb9M5uk5fOfi26IpltazxbZqrQ9VVxb4aUt8hM2uX9YtdrrBi9vHv6qfvyk/l/qy3PJye2z9Pf16+jDevgrvy/elpScZXUwvZyrMZonSzQVuUPrW4RvqHoisWn/+rqcU10iu6JEvCF9fbZdn1hw+Looffr5Hcw7xclD21uEb656I5LAofG+hl2wdAafiYksThz4t41ubpRJQqJR8t8udu78rmk1Dop3r6xHVq5RwIOzZ1V27ZgbBLWo+vTAy9oPW4nVrdT2tXVIeLj9srPje8i+5TV785/FKaqPr6IFe1LBtOXV1NHcqDW8K63pZ5K96K5SGGsKmtUxS63oJ5JVkeBLvdPTTv66e/mOzOvblNFe/rpw/nZnfS+3QBdUKyukofqx09V7vdvvxcNOUP5VPVdheeeG7ezM2VEcXK28XUzQOtoWFhGt6oazHmUl3HK3UtJ0zL6N1aPa7R3pzc439U1/C7dgWwF6zXVoJDpJsf7rVozcK0y9Zg14VjW6/8VLWtdOqg4Ki1uj0UsKz3Auu6Tud5gyci0Kv9SLtdacdlsFzIhy9p8F0ls3VcuuV0WctQt7+o5txMr8d2r++K5/e7whOhzj/ey81sgVpXm228Jk9kOnXZ4r8t3SfQmbSQRDomaVLJO5nkzzBFqxR55u2GKdNPbuDaJPRmQxW5qYtwdYZ6s3kXEldmmjZ9vdms5ayWWaXMbe9hlCfldQ26lPheY8xV+TAz7UJWfI1Va3JlF+pyxnxHOxSrlD+bvtUOdY7tdTRfpn2rZZ78m9lxIQsXXcZOFnwXwOef7pUoUHHaNGGyzuPx76UXonFVY6NrdXwsi50HFJaaud3VmvyHPB1ll891XtZXtd8UbZlErw/beievL5bSqn1v2pfn9tdqFg/ncXWLZ4Iu6/jfU9l8edc11eFpefNiKTW9WtNLt3cRrOAO5s/7p9/u52JEnt7HRgNXOxlVdtnLlrUsuhlVpPKzZV0q4FOdq5C/rLvtiu7UvpIuojtqh7bbpTvoHo0WBP27lvGXO8GPSlOCbzLNB71C9BtL0djmSg3bYr9/X2z/KR4n5480tl08o3FRozdLtXRdOEhwUctz9Vz2Zwslh7IU9Q27seGVusRj8EzNbWNWD+caLikZjzxdr6ctmz6r+7/L82O1vF7bp7L5ToWHoe2tqPhUNq10r5spm5ut0ENCzjdFW23FywnnX+4ScmxpqpAzm+ZNTdr2c924iwJTRtpdqenU9gcVBNdhmki7FZqk6RjeguDXN/x+36khMtdN0Gisv75EjtwPr5QQY7hoiN17eJ2EboiXrVqeTmrBldqsLaJ4Tkr73Ddr950kWjRg7NTbsRs6rR5v8aUdjvb5p7vAmYlTIZlY54HLz55cgGv7eSVTe1mzj/Lgmhdelne1Zs92yFUtECGrddsOczzuv/xXWx/eFt3WXZy4Bab5L219OI7N72WHe9LUZ8LlI6Uqbb4ij6DuEs2l1KecZKPwAuElY4reb790LYo3uEtIEIWqAoNj70Vq4seieSrd6fOaMHbrpm632TFRuqusmDpdbwMr1I5NlOpp+9s0tx/r0373ZqX+oddNVlCIf+fnW+af7gJrJk4FaGKd/7aUJ+JxfU8XI55K26tT29XPep1b0/4emsf7anrV48W0a3RTiPztMt3kNrkLZDxiVdARrF68qjvkg25Vw2dD3+fDuc99bKibft+/zoa5z+028FdU6C3hV3+vtcdKqna7hb2ld0x2u3lq7mfFMMxrrTj3uoMVF5ORBVvUN7MXLRKufnoKwNavdwkFrkRVFLDN9KYh8ikSQad0cmS1vlNbfm3VCTSaT21Z8E4rbSDT97apDtvqSO5rTKrPv9xl2mxpqimbTfNtbsViCNM0NdLtrCSdLDZqlC7WXsTnIlMybqW+6a8AC5HG/nlxcuxLyZSQEr/zJUj+ymKlFhk4ZrbfCk/h1qO92i6+T0aptToUzRf9Q5vm93hatcY76Op/1ikbW96ibeBIVerOTW/X5+YhfoX+zEOn0fD0Kn1Ty5u1mVMEumc07Y9T+1s078p9KVR3JaXnpjfpc99eIery3+HT6ZEKCZKipdqBTtNRrPVJutwy3xXaaqHMJiqrF4psSl0nparTFZromuc5iD38+S4JCBGlyj5Gi245e0lVrriL5GoWzzVeesJzq2u07Kp2W38qm68POzNxP9SnTmD6qcqpS3HYmQWmmbpco//Y1NuybV9/6hsvaR0blmNDpS4XekMxxbOLcZvcEZKO2BXwtKz2ZMkf7Dc6XFJ+bn6r3r11C/6S2qn1zVrrpx+r57Ltimf32K9Xef3UkU5X2GC9wEYoVpD3fLxR8uDryOgFBeu56Dcreegl5VcoukxBK5/2JsU+9nlJt5Z89qjnIGK1Jq55+FkPosU5I8IUczZatjBnpoVKG229SiUdrm8rc6GnIMsw1Tn/vLxhpiL9r+oZf9KPPIvBHlGXYu9kkSrg+nQsB1pXBdsr0LeS+FQsv5lEo4Jf51rUdKkUd0GhffvTp2n5/qdGhfaZTON7PNP/VN3Hd12x/adO5eeq+9iOza9Sar/2xYvxxVe/aFRoB9I0vnEgK8/73yxFiy+cUSjQPlDf9tbnab8nr7jxKmqXXnRzQYUJMNpHMo1vfKZ9fTkkDW2uEm+/ucenYPntPRoV2iEzjW8cMut9QT5Fi+8MUijQPlDf9prnsV8k5x66Gl4hd/77hUq5La3nwqU34Z3/viiNvmlOfNlbIb7YzSdAOIRoiVKeRLSFsg9WWAKH31YLu2Qnb7VCgfuVc0vy0sfNfSL5iTVLoOZiIhfHDqQxeYprWLbAd+On6GSB069agRYTMUvq/6wV4XzHYxYz/bRC1IiBV4tCWaP14r1cuaRm1SE+Ud3f7Q8mSEqGJutFv+Xv+5eET43Wi/9BepG/pII21Kr59vV3r398LYgdftCK8X44ZRbIm2hF//X1j4K0v77+USuA8WGzjOEHrZiDD0CHVbB5+/WPr/5TkGL+rhXS3461v/w8Czr/prbo+3fSCPd/VtvjHFUg9qgOK1jCvO50XOlEb/8hPtk/1A82c3+CnPlHrbim+PyNHO3HX9SCvCtks255dE7kU0nrFkbxgyNE3BXRqS/9SrLM3yUhPz1sqsOu/HXz8rfzfbeXG3wRvsg3D5sPVbnftZuXj1O9bVs/Pw/sxK7ensx//jQ2++9y+CLNy8eh9Z+DzcNj8BCHL0KAn356eJw6mx/MHyYZ819MR9g8PILUEZyOYHXEzcMjPmD0Ik9zqyM6HdHqGG4eHsOHKHqRhZnVMXQ6hlbHaPPwGEkdI6djZHWMNw+P8UMUvAjB7hg7HWOrY7J5eEwkjYnTMbE6ppuHx1TqmDodU6tjtnl4zKTpyJyOmdUx901H7nTMbQAEvvkAFzvAwAO+KQEBPjZ+AH2zAi6CwIYQhL6JARdEYKMIIt/cgIsjsIEEPTzyhyh7gUFo93WhBDaWoEcIBGJnF05g4wlS3/SCiyiwIQWZd6BdUIGNKuixAvAQ4os8QruzCyywkYU9WAAlzehCC21ooQlMoTRc6GILWWzq4QKR2FkITza4MPRGNhdcaIMLI99YowsutMGFsXes0UUX2ujCxD/WLrrQRhem/rF24YU2vLBHDMRSzEIXX2jjC3OfQ6ELL7ThFRp4JZLi0IVXaMMrNPBKxc4uvEIbXqF37QtddIVs9fMvf8L6Z6Mr9K6AoYuu0EZX6F0EQxdcoQ2u0LsOhi62QhtbocGWuKSFLrZCG1uhwVYudnaxFdrYCs2SKCZFoQuu0AZXFPhWicjFVmRjK+rRgmJSFbnYimxsRV5sRS62IhtbUeiNIJELrohlVz1eEEWrhQTLRlfUAwZDsbMLr8iGV5R4H9mFV2TDKzILYyQqduEV2fCKesBgLM6yC6/Ihldk4CWGn8iFV2TDK+4Rg6kU+GIXX7GNr9jgS3Sp2MVXbOMrNvjKpWeOXYDFNsBiE7xEl4pdgMU2wOIeMiE8RPgixNju7AIsZim8f3GMhSzeBljcYyZE8ZldhMU2wuIeM6EYsWMXYbGNsLjHTCiG7NhFWGwjLO4xE4rwjF2ExTbCEpPWi/BMXIQlNsKSHjOhuDomLsISG2GJN4IlLsASG2BJ6PXIxAVYYgMsibxZX+ICLLEBlsRev0hcgCVsn2gAlomaha2iDbAk9fpF4gIssQGWGICJGVTiAiyxAZb0kIlEd05cgCU2wNIeMpG4yqUuwFIbYCl43Tl1AZbaAEvR686pi7DURljaYyYSl7nURVhqIyyNvLEgdRGW2ghLY28sSF2EpTbC0sQbC1IXYSmrRqTe1SYVChI2wtIeM5G4tKcuwlIbYalBmLg8py7CUhthmUGYuLPIXIRlNsIyU5oQ41/mIiyzEZb1mInE+Je5CMtshGUGYXIRx0VYZiMsMym+mPFmLsIyG2GZyfFFf85chGU2wrIeM7Hoz5mLsMxGWOatT2QuwDJW8jL1CdEjM6HqZQMs6yETi+jMXIBlNsDyHjKxiM7cBVhuAyzvIROL6MxdgOU2wHL0xr/cBVhuAyzvIROL0M5dgOU2wHJToRChnbsAy22A5QZg4jqXuwDLbYDlBmAitHMXYLkNsLzHTCJCO3cRltsIy3vMJCAFz9xFWM4Kqz1mEnG1yYXaKi+u9qBJPOVVqb7KCqxBj5tELrEGQo01YEXWoIdOIq4bw2+8Pyu0BqbSKmJt+I33Z8XWoAdQIi49w2+8Pyu4Bj2Gkky2X6i5BqzoGpjShVyyDYSya8DqroGp5MtV20AovQas9hr0YEplgiUQyq8Bq78GPZ5SlPULFdiA4c8U7FOxtAdSfd8p8Pd4SsUQCWKNn+EPvJsBkMr8vM5vavdpLJsvwI/X+odiv8wUSOV+Xu83NfxUhq9U8uc1f1PGT8WACVLVn5f9TSk/leErVf556d+U8zMZvlL1n5f/TUU/EyMnSAQAYwDAFPUzMXiCwAEAIwHA1PWzUNobgUADAOMBwJT25eANAhMAjAoAU973hG+BDQBGB4Ap8XvCr8AIAKMEwFT5M3FLCwIpAIwVAFPoz8QkBQReABgxAOjnnQRmABg1AKban8mrh0AOAGMHwFT8MzFZAYEgAMYQgCn6Z2IqDgJHAIwkAFP396w+Ak0AjCcAU/uXWRkQqAJgXAGY+n8mFiVAoAuA8QVgOIBczJpAoAyAcQZgeAB5+gXWABhtAIYK8ERvgTkARh2AYQM80VsgD4CxB2AIAU/0FvgDYAQCGE7AE70FCgEYhwADiSBHb4FGAMYjgKEGPNFbYBKAUQlg6AFP9BbYBGB0AhiGwBO9BUIBGKMAhiTwRG+BUwBGKoDhCTzRW6AVgPEKYLgCT/QWqAVg3AIYusATvQV2ARi9AIYx8ERvgWAAxjCAIQ1ykPsL+GMkAwwsg+i+AssAjGYAwxzkKE6fQDQAYxrAkAe5PPwC1wCMbICBbfActxDgx/gGMBRCLg+/wDgAoxzAsAhytQ8E0gEY6wCGSMjlxVfgHYARD2C4hDyR7Rfgx7gHMHSCZ/oF9DH2AQyh4Jt+AX2MgADDKXimX6AggHEQYGgFz/QJLAQwGgIMtZDLyYPARACjIsCwC57VRyAjgLERYAgGefgFOgIYHwGGYsjl3EVgJIBREmBYhlwst4BASgBjJcAQDZ7gL/ASwIgJMFwDBHLyIXATwMgJSBbOHgn0BDB+AgzlAIG89xYoCmAcBQwkRSBWJkGgKYDxFGCoBwjE6iQIVAUwrgIM/QCBvP0W6ApgfAUYCgICOQUTKAtgnAWk/gxQIC2AsRaQDofe5B2AQFwAYy7AkBEQyF4skBfA2AtIBxjKfiQQGMAYDEi9JytBoDCAcRiQDSiUVzGBxgDGY0Dmp8pAYDKAURlg2Am5+AkCmQGMzQBDUHgqkAKfAYzQAMNRyNwoCJQGME4DMj8CBVIDGKsBhqgAkMOQQGwAYzbAsBWePZxAbgBjN8AQFp49nMBvACM4IBvCoBzGBI4DGMkBA8shT4BAcwDjOSAfACiHQYHqAMZ1wEh2yGFQoDuA8R1gKAyZIQeB8QBGeUDuX4kFzgMY6QH5cPZEjsIC7wGM+IB8wKCcCQrcBzDyAwyfAfJZRxD4D2AECBhOA+TzjiBwIMBIEMgXCoECDQKMB8HAuxVBgQZBRoNgMGBQjOIo8CDIeBAMBgyK6RAKRAgyIgQNsQHycUIUmBBkTAgG/s0wCkwIMiYEA28cRIEIQUaEYDAcEBbDCApMCDImBIMhDophAAUqBBkVgobaAPmQIApcCDIuBA23AfJhPxTIEGRkCMJwIF0+qyywIcjYEDTsBsiH/lCgQ5DRIQhDQVD0QxQIEWSECIL/cLrAhyDjQ9DwGyCfHUSBEEFGiKAhOABlPxIYEWSMCA7XIEKxqIUCJYKMEkH/VQgUGBFkjAgahgNC2Q8ESgQZJYILVyJQoESQX4oYbkWEsh9J9yL4xYjxZoTsR9LdCOdyBPo3BSjej2AgNCwHhLIjSpck+C0JQ3PIpQWULkrwmxLDVYlQdmTpsgS/LTFclwjF2gpKFyb4jQnDdMjFDZTuTPBLE8OtCfmIJUr3JvjFCUN1QCh7snR5gnEjOFyfkMtrKJAjyMgRHK5QyMcHUWBHkLEjOLAjkVjfRIEeQUaPoKE7IBLZcRT4EWT8CIbDiVH55otAkCAjSNAwHv3bPUUBAhAZRYKG8gD5kBsKHAkyjgRDfzgUKBJkFAkaysOTlQgUCTKKBA3lAfI5OxQ4EmQcCRrOA+SzdiiQJMhIEowGGMqOILAkyFgSjAYYykuaQJMgo0kw8q/JAkuCjCVBw3pALK+IAk2CjCZBQ3tALPuRwJMg40nQ8B4gH8FDgShBRpSgIT5APoaHAlOCjCnBKPNXSVCgSpBRJRgtrMoCVYKMKkHDfchVEhS4EmRcCcb+c1oocCXIuBI03AfIZxFRIEuQkSUY++/+oECWICNLMB5QKAcigS1BxpbgcENDPpaIAl2CjC7BeEChHAkEvgQZX4JxuuBIAmGCjDDBOFtwJIEyQUaZoKFA5NNuKFAmyCgTNBQIxHIsEzgTZJwJJv4DCyhwJsg4E0wGGMqxUCBNkJEmaEgQkA9qosCaIGNN0NAg8oE9FGgTZLQJGhoEEjm/F3gTZLwJGh5EPvGHAm+CjDdBw4NAIgdTgThBRpzgQJwkcjAViBNkxAkOxEkixxKBOUHGnODAnCRyLBCYE2TMCRoiRD61iAJxgow4wYE4kY+dokCcICNO0PAg8rFHFHgTZLwJDrxJIscigTdBxptgOsBQ9mSBOUHGnODAnCSyJwrMCTLmBAfmJJU9UWBOkDEnODAn8tlVFJgTZMwJDsyJeHwCBeoEGXWCA3WSyp4kUCfIqBMcqBPZlQXqBBl1goYKkc9foECdIKNO0FAhMoGPAnWCjDpBQ4VAKkcCgTtBxp2gIUM8+2yBPEFGnqDhQuRLcShwJ8i4Exy4E/n4MArkCTLyBLMBg563C0ivF2AYHNiTVI4kAnuCjD3BfAChHAkE+gQZfYIDfZLKkUCgT5DRJzjQJ56NukCfIKNPcIE+QYE+QUafYB4t7NMFAgUZgYIDgeKptggECjICBXP/BV4U+BNk/AkO/ImnUCDwJ8j4Exz4k1SOxgJ/gow/wTxfqDQIBAoyAiUMAn/dNBQolJBRKKFhROTrh6HAoISMQQkHBkUudYQCgxIyBiUcGJRMfiGDwKCEjEEJDSMCmbgghQKFEjIKJQxiL5UbChxKyDiU0FAiMpUbChRKyCiU0DAi8iXOUGBQQsaghAODkokLYigwKNPfzHvHPpVNV+7eDO8fe3ycv/D+2+bn8a1kPU1uVPUvKOuJ8Je//f77/B6yl7/9Tl5F1v/Waxu/k0ekhDBL6cvnGinso5tE2vyi+t82PaOzQtr0GQQqLaa2BVpp7ucvqcyEygSdzP71vkRGSka+z8SUMorjkYpJyViB3pLhHa/EGiJljYzhfeaznGyWo0TBsdqSdwHT8aGYStXSdmW7barj8ALgWRzFVKQe7PFV/uT5CJj6qxNKOdX4BmViDxEUZUPPJBz+7dPiVYJ9I4hkBDMl8o/Vvnh+vysYznIaJ8JIK4tHCuo4kfop6/mVzuTxqEXJOHKZGr1nmRzCQKMPjjOjfuDj8G5OOguzuFBtnRHDLYsJZnK1qPOrOclkUncfpqEfO1wpktuH5FHjYOiuD2zzmz+JoQQu/WHn0dBQK7M9vxibTkhI3UI9s+343TkSe2kwgNF5+ystOonH7fgJMSKRPi9Ek8TxwSHRPngvuiuqA7M3pdLjSbo2tB73X35p68P4YUKaQ1A4ZUqvtj69NAtLiKx8jIuQjW6IsTKIWV+x2lXt+MWAWU1EMKBdW7yfxqIxKadDMfoARnoNQzrkeBYZlUjp+fRb8zR1octqoMTq/NklIomGo54bWCWJW0WXqkAZM05dXR1+Kc07eM9fhSBwzyjckwnuOnz2HzO2IhEVlsRqGeyDyDRnpmEIdZNKPnJMQUfjUDpGDURdOD+LFBLxgD600k3oB5Hp01qrqi6OcSE50tUAxgmNp/ULpyfPlNMzfNuYGkkRjSuk1Mfy0C8Rx3JrLdjE4Ew3fNtiv39fbP/JI0tOA0uic1vzImoqhCBuWq3GEBXqZsRItL45SWIUAUusgzP59CjNv+jmSumuZ0lsl5WQGchHoMCU1fW3B1cKt3LihIxn/xqPUfo0tJFyljzDSQZh6DmZP6VBo55w/Dma/h0jXTL+fzZlDzA9Nk5/CaccYMrW+hthY6oxJR/p1Cad9GfTX/LJ4aZn74+gDv8xZUM4Wzv9R6SE2vlrH2RMiBPEU2o+qVQWL/rMqDx0/Td6rISALLDTeI3jq1vZ5D1YSJwimZYgZc45S5TGAujOHzPdkjmLXCxv0MQWtYHrLNpJXoib6D1uFHaoneWOJsmoTDdngfPXHKhIkhn35fx1Is2XBIrpQwNUbEbFqmPiKLbtv5xhJTR0DZgcq79Cvk5uVzTmQ+Y0g6dVpFw3R+OnG0k4pNuLYIoNsW6C7M8z0iyTjmGie9bp4/N0ac/pojLFq1yXI3lqSsRLppA4hdhsCnZjDFEOqee72HRxpEhVTv2O1Tdo4VFZkpBmhi74CLqYVh52x7o6dHK0zOj2F3VxZ5K4FNAiAm9lbW0Sy4NZSMY/0Y7dIOq57D7W1hBm1GNwnWGDNFMnKvkmL6N5e6gDySTXThgJVGLduj3JkaIM3afkuuXaqcAm9NmCcxFjXKxROyfWl1NpuKFxItGFhyXoUWYkHqNBMoXufMqScuXYMkVsD003lIHSe9jnXIm4hIYJZeWp/LV4Pu7tgg7xl2myxqCoRMCvx329s6M5wUCoy3zKX4910/n2aWTklAnF+PluSwrx5lwZDvlHwMm40SU5mDa72YQY5Q5r/IQuEUtziGAqmyvr2/ZncilWaFFJWR2ZvmBNnY9CLjpnELoZ/nDa73nGFJGIoyRAeNCK6KNNey1Uzu9T2VmZ57FuduWH4rS3dERkTpR7g17wqe3qZ4nSpSEs0IWwp7IbDRMEIp2WQBcJnkpJEnVcDHQQfiq7utk2ZdGVS7QNxY6yAEQkCyQJWJugKwU66QMNhzpATp8LpMks3QHh5MTKvH2QZy0dOS1kTBtrSKYsGXUO+LHrjm6OQxPvZKouKHOJylOXpPEalWxu5TkeENNtdKzzlmpXmaJz0dhFzpjOS6ybjkpwE7qS9GfeVXIY0ujxAgim4ouycmh9PpzGeVqVSpQDf6i6qtj3XNy8tbWWJJoWBuci1VSG0c7vWY2dYtNhmLZloORQzqmWHcToLiXXWteVzcFeiollukhQnbP9MW+wU02KZGUNo2otjsKKCTT/mDJXUKbX41fhKXKoyya6cCqzjXQDgKnOycy3420Xo8t6NNUQY51h9qfoqW00mCS6TNJ8b57KoOtOqpvHff30weDBikcZ5WVhKt9OdWLI1fYJqRrNI/uD6EpJLNJllNHBqQgdTRV0ZYTZ10/OBCfUSZU5y75+6j/k2XbF89EGCw17yrL+c9k8lTwo0+R7wpxuFoy46YiEve8jT6rc67urNK0JKXE7COE8FU2XleB9rna7ffm5aMqmfKrajoGY5iY47YPOm4NznVF5jOG5ei772r89hIF1lkgnyeH+qbdNnOQ4yROi4/H/0/E58nOudSZXpkLGWcT5fI4yaXIr5iGBbzxmi+l5J6ODM4vn9HAeKGsN4+bbHngqR4mXUY57egboASQEXS43SnNDHK0EaQdpkPVUHvpNCludyZMqqSp3ubdQG5FpTXXYmMuF9anZ2nUa4gLKpOZYtO3nurGXwIAGXuXC4C7y9NkwPJfJtHYx/JMQMh0im45JgDJN72UKZ/voKpjr3OBYs30mPYuE4RTPlKsz+dI53SDSHft09CUMdP51bOpt2bblp/6PlqE081Km0BLdRs+CTITzRDOHyqrA8cRso5lXeBamiwHmw+n2ANJIotz9GykuRugOJFRmIrMoe52idDIqMwcjq+2a6vAkswU53X8pd5tN8dk54kPTzTDQ1bGkuot1FGz0hnPp+EywpdMU6/x3VGRoNV5NoQpR5yOjON9hAhIDlSeSe4FVw7YTJLoo0xvpEG1Gs84plkKWTQOonPFRsu+RicMoDxLL2SwNhlMupAv7hoa3bKK3EXSO56Py6cmw6cBZeo6rSvtOFnuc0Q32lCiC8qjodLB5OIbqnLggiI50jtiWTV894dWxgG7QUh2U3YPSQOvwqOR9BjFCdSygO4JUhzUqTEgcaQUeI61IocJNTyvk53NSupjSlp0UDmk8BOUhEiPKjQRAvQuUhx/aj/Vpv/OUwiiBrcx/3NSTlk2VTGjbFd2p3TJeMKfmKMnbtvtiE5aU7VCePuyrBnbkpoWNULk/6nN8yxJ6fweCaRuo9EIjTaxR0SK10n14tCfjfD6GNPyrPJJyakv7PL2dAVB3BN0Cf2r7Ais/jk8BobyK8qlsWueqEY3Vyr3W56KxhNBrJzCdu8UVwsTJpHlqqgj1Pz1sjtWx3FeHcvPy8afff/9/3kA8QA=="; \ No newline at end of file +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 diff --git a/docs/assets/style.css b/docs/assets/style.css index 5ba5a2a9..44328e99 100644 --- a/docs/assets/style.css +++ b/docs/assets/style.css @@ -1595,9 +1595,9 @@ .container-main { grid-template-columns: minmax(0, 1fr) minmax(0, 2.5fr) minmax( - 0, - 20rem - ); + 0, + 20rem + ); grid-template-areas: "sidebar content toc"; } diff --git a/docs/classes/ApiApp.html b/docs/classes/ApiApp.html index cc57a07b..d087308c 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 @@ -25,30 +25,30 @@ declare controllers. Required if the default Container is used, or the autoInjectionEnabled is set to true. Ignored if the autoInjectionEnabled is set to false.

-
  • appConfig: AppConfig = ...

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

    -
  • autoInjectionEnabled: boolean = true

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

    -
  • appContainer: Container = ...

    (Optional) InversifyJS IOC Container instance which can +

  • appConfig: AppConfig = ...

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

    +
  • autoInjectionEnabled: boolean = true

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

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

    -

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

    • Run using the passed event and context, ultimately should call the processEvent method on the apiServer instance.

      Parameters

      • event: ApiRequest

        API Gateway or ALB request.

        -
      • context: any

        Request context.

        -

      Returns Promise<ApiResponse>

      The response.

      -

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +
  • context: any

    Request context.

    +

    • Returns Promise<ApiResponse>

    The response.

    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/classes/ApiError.html b/docs/classes/ApiError.html index 5218a7e6..d972f5d5 100644 --- a/docs/classes/ApiError.html +++ b/docs/classes/ApiError.html @@ -1,6 +1,6 @@ ApiError | ts-lambda-api - v2.5.2
    ts-lambda-api - v2.5.2
      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 9d421dd2..c1a312f8 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 @@ -21,28 +21,28 @@ Required if the default Container is used, or the provided Container instance has its autobind flag enabled. Ignored if the provided Container instance has its autobind flag enabled.

      -
    • OptionalappConfig: AppConfig

      (Optional) Application config to pass to lambda-api.

      -
    • OptionalautoInjectionEnabled: boolean

      (Optional) Enable auto injection in IOC container, defaults to new true.

      -
    • OptionalappContainer: Container

      (Optional) InversifyJS IOC Container instance which can +

    • OptionalappConfig: AppConfig

      (Optional) Application config to pass to lambda-api.

      +
    • OptionalautoInjectionEnabled: boolean

      (Optional) Enable auto injection in IOC container, defaults to new true.

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

      • Process the passed lambda event and context as a synchronous HTTP request.

        +

      Returns void

      Settings

      Member Visibility

      On This Page

      Constructors
      Properties
      Accessors
      Methods
      +
    • context: any

      Request context.

      +

      • Returns Promise<ApiResponse>

      The response.

      +

      Settings

      Member Visibility

      On This Page

      Constructors
      Properties
      Accessors
      Methods
      diff --git a/docs/classes/ApiRequest.html b/docs/classes/ApiRequest.html index 291fe645..29baf98a 100644 --- a/docs/classes/ApiRequest.html +++ b/docs/classes/ApiRequest.html @@ -1,7 +1,7 @@ ApiRequest | ts-lambda-api - v2.5.2
      ts-lambda-api - v2.5.2
        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 33b6eeb4..c13dbb34 100644 --- a/docs/classes/ApiResponse.html +++ b/docs/classes/ApiResponse.html @@ -1,11 +1,11 @@ ApiResponse | ts-lambda-api - v2.5.2
        ts-lambda-api - v2.5.2
          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 1dd34e52..b304c8fc 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? @@ -16,22 +16,22 @@ version?

          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 f76f6d81..90d81e92 100644 --- a/docs/classes/BasicAuth.html +++ b/docs/classes/BasicAuth.html @@ -1,6 +1,6 @@ BasicAuth | ts-lambda-api - v2.5.2
          ts-lambda-api - v2.5.2
            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
            diff --git a/docs/classes/BasicAuthFilter.html b/docs/classes/BasicAuthFilter.html index 2096781f..6ff8b438 100644 --- a/docs/classes/BasicAuthFilter.html +++ b/docs/classes/BasicAuthFilter.html @@ -1,14 +1,14 @@ BasicAuthFilter | ts-lambda-api - v2.5.2
            ts-lambda-api - v2.5.2
              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 extractAuthData -

              Constructors

              Properties

              authenticationSchemeName: string = "Basic"

              String to use in WWW-Authenticate header when returing +

              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 cb30b870..3df62306 100644 --- a/docs/classes/Controller.html +++ b/docs/classes/Controller.html @@ -1,7 +1,7 @@ Controller | ts-lambda-api - v2.5.2
              ts-lambda-api - v2.5.2
                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
                +

                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
                diff --git a/docs/classes/ErrorInterceptor.html b/docs/classes/ErrorInterceptor.html index 5f6ee0ec..74a960d5 100644 --- a/docs/classes/ErrorInterceptor.html +++ b/docs/classes/ErrorInterceptor.html @@ -1,6 +1,6 @@ ErrorInterceptor | ts-lambda-api - v2.5.2
                ts-lambda-api - v2.5.2
                  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 @@ -9,11 +9,11 @@

                  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?

                    +

                  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 +

                  • 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 00e97464..6aa7e021 100644 --- a/docs/classes/LogFactory.html +++ b/docs/classes/LogFactory.html @@ -1,22 +1,22 @@ LogFactory | ts-lambda-api - v2.5.2
                  ts-lambda-api - v2.5.2
                    Preparing search index...

                    Class LogFactory

                    Builds implementations of [[ILogger]].

                    -
                    Index

                    Constructors

                    constructor +
                    Index

                    Constructors

                    constructor

                    Methods

                    getLogger getCustomLogger getDefaultLogger

                    Constructors

                    • Build a new log factory using application config.

                      Parameters

                      • appConfig: AppConfig

                        Config object to read logging config from.

                        -
                      • logLevel: LogLevel = LogLevel.info

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

                        -
                      • 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? +

                      • logLevel: LogLevel = LogLevel.info

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

                        +
                      • 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? +

                      • 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 e51f67aa..4940e3d9 100644 --- a/docs/classes/MiddlewareRegistry.html +++ b/docs/classes/MiddlewareRegistry.html @@ -1,6 +1,6 @@ MiddlewareRegistry | ts-lambda-api - v2.5.2
                    ts-lambda-api - v2.5.2
                      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 @@ -10,19 +10,19 @@

                      Constructors

                      Accessors

                      Methods

                      Methods

                      • Add an authentication filter.

                        Parameters

                        Returns void

                        If the authFilter parameter is null or undefined.

                        +

                      Returns void

                      If the authFilter parameter is null or undefined.

                      • Adds an authorizer.

                        Parameters

                        Returns void

                        If the authorizer parameter is null or undefined.

                        +

                      Returns void

                      If the authorizer parameter is null or undefined.

                      • Adds an error interceptor.

                        Parameters

                        Returns void

                        If the errorInterceptor parameter is null or undefined.

                        +

                      Returns void

                      If the errorInterceptor parameter is null or undefined.

                      Settings

                      Member Visibility

                      On This Page

                      Constructors
                      Accessors
                      Methods
                      diff --git a/docs/classes/OpenApiConfig.html b/docs/classes/OpenApiConfig.html index 2d916244..9bb9337e 100644 --- a/docs/classes/OpenApiConfig.html +++ b/docs/classes/OpenApiConfig.html @@ -3,6 +3,6 @@ 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 3711f5f1..07a9daaa 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 4c47c5e7..7b4a0e2e 100644 --- a/docs/classes/RequestBuilder.html +++ b/docs/classes/RequestBuilder.html @@ -1,6 +1,6 @@ RequestBuilder | ts-lambda-api - v2.5.2
                      ts-lambda-api - v2.5.2
                        Preparing search index...

                        Class RequestBuilder

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

                        -
                        Index

                        Methods

                        base64EncodedBody +
                        Index

                        Methods

                        base64EncodedBody basicAuth binaryBody body @@ -17,43 +17,43 @@ put

                        Methods

                        • Add basic authentication to the request.

                          +

                        Returns RequestBuilder

                        This builder instance.

                        +

                        • Add a binary HTTP body to the request.

                          +
                        • password: string

                          Password to send.

                          +

                        Returns RequestBuilder

                        This builder instance.

                        +

                        body

                        Returns RequestBuilder

                        This builder instance.

                        +

                        body

                        • Add a HTTP header to the request.

                          +

                        Returns RequestBuilder

                        This builder instance.

                        +

                        • Add multiple HTTP headers to the request.

                          +
                        • value: string

                          Value to set.

                          +

                        Returns RequestBuilder

                        This builder instance.

                        +

                        • Add a HTTP query parameter to the request.

                          +

                        Returns RequestBuilder

                        This builder instance.

                        +

                        • Add multiple HTTP query parameters to the request.

                          +
                        • value: string

                          Value to set.

                          +

                        Returns RequestBuilder

                        This builder instance.

                        +

                        • Start building a HTTP DELETE request.

                          +

                        Returns RequestBuilder

                        This builder instance.

                        +

                        Returns RequestBuilder

                        • Start building a HTTP GET request.

                          +
                        • path: string

                          URL path to request.

                          +

                        Returns RequestBuilder

                        • Start building a HTTP PATCH request.

                          +

                        Returns RequestBuilder

                        Staticpost

                        • post(path: string): RequestBuilder

                          Start building a HTTP POST request.

                          +

                        Returns RequestBuilder

                        Staticpost

                        Returns RequestBuilder

                        Settings

                        Member Visibility

                        On This Page

                        Methods
                        +

                        Returns RequestBuilder

                        Settings

                        Member Visibility

                        On This Page

                        Methods
                        diff --git a/docs/classes/Server.html b/docs/classes/Server.html index f737f9c3..8bd39a58 100644 --- a/docs/classes/Server.html +++ b/docs/classes/Server.html @@ -1,19 +1,19 @@ Server | ts-lambda-api - v2.5.2
                        ts-lambda-api - v2.5.2
                          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 processEvent

                          Constructors

                          • Create a new server.

                            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 +

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

                          • Takes an API request passed in by AWS Lambda and processes it using the lambda-api package.

                            Parameters

                            • request: ApiRequest

                              API Gateway or ALB request.

                              -
                            • context: any

                              Request context.

                              -

                            Returns Promise<ApiResponse>

                            The response.

                            -

                          Settings

                          Member Visibility

                          On This Page

                          Constructors
                          Accessors
                          Methods
                          +
                        • context: any

                          Request context.

                          +

                          • Returns Promise<ApiResponse>

                          The response.

                          +

                          Settings

                          Member Visibility

                          On This Page

                          Constructors
                          Accessors
                          Methods
                          diff --git a/docs/classes/ServerLoggerConfig.html b/docs/classes/ServerLoggerConfig.html index 3ba58940..80afc243 100644 --- a/docs/classes/ServerLoggerConfig.html +++ b/docs/classes/ServerLoggerConfig.html @@ -1,5 +1,5 @@ ServerLoggerConfig | ts-lambda-api - v2.5.2
                          ts-lambda-api - v2.5.2
                            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 b65cbc78..a0bd6c60 100644 --- a/docs/classes/_internal_.Agent-1.html +++ b/docs/classes/_internal_.Agent-1.html @@ -1,6 +1,6 @@ Agent | ts-lambda-api - v2.5.2
                            ts-lambda-api - v2.5.2
                              Preparing search index...

                              Class Agent

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

                              v0.4.5

                              -

                              Hierarchy (View Summary)

                              Index

                              Constructors

                              constructor +

                              Hierarchy (View Summary)

                              Index

                              Constructors

                              constructor

                              Properties

                              freeSockets maxFreeSockets maxSockets @@ -14,12 +14,12 @@ errorMonitor

                              Methods

                              [captureRejectionSymbol]? addListener -createConnection +createConnection destroy emit eventNames getMaxListeners -getName +getName keepSocketAlive listenerCount listeners @@ -40,34 +40,34 @@ on once setMaxListeners -

                              Constructors

                              Properties

                              freeSockets: ReadOnlyDict<Socket[]>

                              An object which contains arrays of sockets currently awaiting use by +

                              Constructors

                              Properties

                              freeSockets: ReadOnlyDict<Socket[]>

                              An object which contains arrays of sockets currently awaiting use by the agent when keepAlive is enabled. Do not modify.

                              Sockets in the freeSockets list will be automatically destroyed and removed from the array on 'timeout'.

                              v0.11.4

                              -
                              maxFreeSockets: number

                              By default set to 256. For agents with keepAlive enabled, this +

                              maxFreeSockets: number

                              By default set to 256. For agents with keepAlive enabled, this sets the maximum number of sockets that will be left open in the free state.

                              v0.11.7

                              -
                              maxSockets: number

                              By default set to Infinity. Determines how many concurrent sockets the agent +

                              maxSockets: number

                              By default set to Infinity. Determines how many concurrent sockets the agent can have open per origin. Origin is the returned value of agent.getName().

                              v0.3.6

                              -
                              maxTotalSockets: number

                              By default set to Infinity. Determines how many concurrent sockets the agent +

                              maxTotalSockets: number

                              By default set to Infinity. Determines how many concurrent sockets the agent can have open. Unlike maxSockets, this parameter applies across all origins.

                              v14.5.0, v12.19.0

                              -
                              options: AgentOptions
                              requests: ReadOnlyDict<IncomingMessage[]>

                              An object which contains queues of requests that have not yet been assigned to +

                              options: AgentOptions
                              requests: ReadOnlyDict<IncomingMessage[]>

                              An object which contains queues of requests that have not yet been assigned to sockets. Do not modify.

                              v0.5.9

                              -
                              sockets: ReadOnlyDict<Socket[]>

                              An object which contains arrays of sockets currently in use by the +

                              sockets: ReadOnlyDict<Socket[]>

                              An object which contains arrays of sockets currently in use by the agent. Do not modify.

                              v0.3.6

                              -
                              captureRejections: boolean

                              Value: boolean

                              +
                              captureRejections: boolean

                              Value: boolean

                              Change the default captureRejections option on all new EventEmitter objects.

                              v13.4.0, v12.16.0

                              -
                              captureRejectionSymbol: typeof captureRejectionSymbol

                              Value: Symbol.for('nodejs.rejection')

                              +
                              captureRejectionSymbol: typeof captureRejectionSymbol

                              Value: Symbol.for('nodejs.rejection')

                              See how to write a custom rejection handler.

                              v13.4.0, v12.16.0

                              -
                              defaultMaxListeners: number

                              By default, a maximum of 10 listeners can be registered for any single +

                              defaultMaxListeners: number

                              By default, a maximum of 10 listeners can be registered for any single event. This limit can be changed for individual EventEmitter instances using the emitter.setMaxListeners(n) method. To change the default for allEventEmitter instances, the events.defaultMaxListeners property @@ -92,13 +92,13 @@ listeners, respectively. Its name property is set to 'MaxListenersExceededWarning'.

                              v0.11.2

                              -
                              errorMonitor: typeof errorMonitor

                              This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

                              +
                              errorMonitor: typeof errorMonitor

                              This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

                              Installing a listener using this symbol does not change the behavior once an 'error' event is emitted. Therefore, the process will still crash if no regular 'error' listener is installed.

                              v13.6.0, v12.17.0

                              -

                              Methods

                              • Type Parameters

                                • K

                                Parameters

                                • error: Error
                                • event: string | symbol
                                • ...args: AnyRest

                                Returns void

                              • Alias for emitter.on(eventName, listener).

                                +

                              Methods

                              • Type Parameters

                                • K

                                Parameters

                                • error: Error
                                • event: string | symbol
                                • ...args: AnyRest

                                Returns void

                              • Alias for emitter.on(eventName, listener).

                                Type Parameters

                                • K

                                Parameters

                                • eventName: string | symbol
                                • listener: (...args: any[]) => void

                                Returns this

                                v0.1.26

                                -

                              • Produces a socket/stream to be used for HTTP requests.

                                +

                              • Produces a socket/stream to be used for HTTP requests.

                                By default, this function is the same as net.createConnection(). However, custom agents may override this method in case greater flexibility is desired.

                                A socket/stream can be supplied in one of two ways: by returning the @@ -107,39 +107,39 @@ a subclass of stream.Duplex, unless the user specifies a socket type other than net.Socket.

                                callback has a signature of (err, stream).

                                -

                                Parameters

                                • options: ClientRequestArgs

                                  Options containing connection details. Check createConnection for the format of the options

                                  -
                                • Optionalcallback: (err: Error, stream: Duplex) => void

                                  Callback function that receives the created socket

                                  -

                                Returns Duplex

                                v0.11.4

                                -

                              • Destroy any sockets that are currently in use by the agent.

                                +

                                Parameters

                                • options: RequestOptions

                                  Options containing connection details. Check createConnection for the format of the options

                                  +
                                • Optionalcallback: (err: Error, stream: Duplex) => void

                                  Callback function that receives the created socket

                                  +

                                Returns Duplex

                                v0.11.4

                                +

                              • Destroy any sockets that are currently in use by the agent.

                                It is usually not necessary to do this. However, if using an agent with keepAlive enabled, then it is best to explicitly shut down the agent when it is no longer needed. Otherwise, sockets might stay open for quite a long time before the server terminates them.

                                Returns void

                                v0.11.4

                                -

                              • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments +

                              • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

                                Returns true if the event had listeners, false otherwise.

                                import { EventEmitter } from 'node:events';
                                const myEmitter = new EventEmitter();

                                // First listener
                                myEmitter.on('event', function firstListener() {
                                  console.log('Helloooo! first listener');
                                });
                                // Second listener
                                myEmitter.on('event', function secondListener(arg1, arg2) {
                                  console.log(`event with parameters ${arg1}, ${arg2} in second listener`);
                                });
                                // Third listener
                                myEmitter.on('event', function thirdListener(...args) {
                                  const parameters = args.join(', ');
                                  console.log(`event with parameters ${parameters} in third listener`);
                                });

                                console.log(myEmitter.listeners('event'));

                                myEmitter.emit('event', 1, 2, 3, 4, 5);

                                // Prints:
                                // [
                                //   [Function: firstListener],
                                //   [Function: secondListener],
                                //   [Function: thirdListener]
                                // ]
                                // Helloooo! first listener
                                // event with parameters 1, 2 in second listener
                                // event with parameters 1, 2, 3, 4, 5 in third listener

                                Type Parameters

                                • K

                                Parameters

                                • eventName: string | symbol
                                • ...args: AnyRest

                                Returns boolean

                                v0.1.26

                                -

                              • Returns an array listing the events for which the emitter has registered +

                              • Returns an array listing the events for which the emitter has registered listeners. The values in the array are strings or Symbols.

                                import { EventEmitter } from 'node:events';

                                const myEE = new EventEmitter();
                                myEE.on('foo', () => {});
                                myEE.on('bar', () => {});

                                const sym = Symbol('symbol');
                                myEE.on(sym, () => {});

                                console.log(myEE.eventNames());
                                // Prints: [ 'foo', 'bar', Symbol(symbol) ]

                                Returns (string | symbol)[]

                                v6.0.0

                                -

                              • Returns the current max listener value for the EventEmitter which is either +

                              • Returns the current max listener value for the EventEmitter which is either set by emitter.setMaxListeners(n) or defaults to EventEmitter.defaultMaxListeners.

                                Returns number

                                v1.0.0

                                -

                              • Get a unique name for a set of request options, to determine whether a +

                              • Get a unique name for a set of request options, to determine whether a connection can be reused. For an HTTP agent, this returnshost:port:localAddress or host:port:localAddress:family. For an HTTPS agent, the name includes the CA, cert, ciphers, and other HTTPS/TLS-specific options that determine socket reusability.

                                -

                                Parameters

                                • Optionaloptions: ClientRequestArgs

                                  A set of options providing information for name generation

                                  -

                                Returns string

                                v0.11.4

                                -

                              • Called when socket is detached from a request and could be persisted by theAgent. Default behavior is to:

                                +

                                Parameters

                                • Optionaloptions: RequestOptions

                                  A set of options providing information for name generation

                                  +

                                Returns string

                                v0.11.4

                                +

                              • Called when socket is detached from a request and could be persisted by theAgent. Default behavior is to:

                                socket.setKeepAlive(true, this.keepAliveMsecs);
                                socket.unref();
                                return true;
                                @@ -148,20 +148,20 @@ it for use with the next request.

                                The socket argument can be an instance of net.Socket, a subclass of stream.Duplex.

                                Parameters

                                Returns void

                                v8.1.0

                                -

                              • Returns the number of listeners listening for the event named eventName. +

                              • Returns the number of listeners listening for the event named eventName. If listener is provided, it will return how many times the listener is found in the list of the listeners of the event.

                                Type Parameters

                                • K

                                Parameters

                                • eventName: string | symbol

                                  The name of the event being listened for

                                  -
                                • Optionallistener: Function

                                  The event handler function

                                  -

                                Returns number

                                v3.2.0

                                -

                              • Returns a copy of the array of listeners for the event named eventName.

                                +
                              • Optionallistener: Function

                                The event handler function

                                +

                              Returns number

                              v3.2.0

                              +

                              • Returns a copy of the array of listeners for the event named eventName.

                                server.on('connection', (stream) => {
                                  console.log('someone connected!');
                                });
                                console.log(util.inspect(server.listeners('connection')));
                                // Prints: [ [Function] ]

                                Type Parameters

                                • K

                                Parameters

                                • eventName: string | symbol

                                Returns Function[]

                                v0.1.26

                                -

                              • Alias for emitter.removeListener().

                                +

                              • Alias for emitter.removeListener().

                                Type Parameters

                                • K

                                Parameters

                                • eventName: string | symbol
                                • listener: (...args: any[]) => void

                                Returns this

                                v10.0.0

                                -

                              • Adds the listener function to the end of the listeners array for the event +

                              • Adds the listener function to the end of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.

                                @@ -175,9 +175,9 @@

                                Type Parameters

                                • K

                                Parameters

                                • eventName: string | symbol

                                  The name of the event.

                                  -
                                • listener: (...args: any[]) => void

                                  The callback function

                                  -

                                Returns this

                                v0.1.101

                                -

                              • Adds a one-time listener function for the event named eventName. The +

                              • listener: (...args: any[]) => void

                                The callback function

                                +

                              Returns this

                              v0.1.101

                              +

                              • Adds a one-time listener function for the event named eventName. The next time eventName is triggered, this listener is removed and then invoked.

                                server.once('connection', (stream) => {
                                  console.log('Ah, we have our first user!');
                                });
                                @@ -189,9 +189,9 @@

                                Type Parameters

                                • K

                                Parameters

                                • eventName: string | symbol

                                  The name of the event.

                                  -
                                • listener: (...args: any[]) => void

                                  The callback function

                                  -

                                Returns this

                                v0.3.0

                                -

                              • Adds the listener function to the beginning of the listeners array for the +

                              • listener: (...args: any[]) => void

                                The callback function

                                +

                              Returns this

                              v0.3.0

                              +

                              • Adds the listener function to the beginning of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.

                                @@ -200,30 +200,30 @@

                                Returns a reference to the EventEmitter, so that calls can be chained.

                                Type Parameters

                                • K

                                Parameters

                                • eventName: string | symbol

                                  The name of the event.

                                  -
                                • listener: (...args: any[]) => void

                                  The callback function

                                  -

                                Returns this

                                v6.0.0

                                -

                              • Adds a one-timelistener function for the event named eventName to the beginning of the listeners array. The next time eventName is triggered, this +

                              • listener: (...args: any[]) => void

                                The callback function

                                +

                              Returns this

                              v6.0.0

                              +

                              • Adds a one-timelistener function for the event named eventName to the beginning of the listeners array. The next time eventName is triggered, this listener is removed, and then invoked.

                                server.prependOnceListener('connection', (stream) => {
                                  console.log('Ah, we have our first user!');
                                });

                                Returns a reference to the EventEmitter, so that calls can be chained.

                                Type Parameters

                                • K

                                Parameters

                                • eventName: string | symbol

                                  The name of the event.

                                  -
                                • listener: (...args: any[]) => void

                                  The callback function

                                  -

                                Returns this

                                v6.0.0

                                -

                              • Returns a copy of the array of listeners for the event named eventName, +

                              • listener: (...args: any[]) => void

                                The callback function

                                +

                              Returns this

                              v6.0.0

                              +

                              • Returns a copy of the array of listeners for the event named eventName, including any wrappers (such as those created by .once()).

                                import { EventEmitter } from 'node:events';
                                const emitter = new EventEmitter();
                                emitter.once('log', () => console.log('log once'));

                                // Returns a new Array with a function `onceWrapper` which has a property
                                // `listener` which contains the original listener bound above
                                const listeners = emitter.rawListeners('log');
                                const logFnWrapper = listeners[0];

                                // Logs "log once" to the console and does not unbind the `once` event
                                logFnWrapper.listener();

                                // Logs "log once" to the console and removes the listener
                                logFnWrapper();

                                emitter.on('log', () => console.log('log persistently'));
                                // Will return a new Array with a single function bound by `.on()` above
                                const newListeners = emitter.rawListeners('log');

                                // Logs "log persistently" twice
                                newListeners[0]();
                                emitter.emit('log');

                                Type Parameters

                                • K

                                Parameters

                                • eventName: string | symbol

                                Returns Function[]

                                v9.4.0

                                -

                              • Removes all listeners, or those of the specified eventName.

                                +

                              • Removes all listeners, or those of the specified eventName.

                                It is bad practice to remove listeners added elsewhere in the code, particularly when the EventEmitter instance was created by some other component or module (e.g. sockets or file streams).

                                Returns a reference to the EventEmitter, so that calls can be chained.

                                Parameters

                                • OptionaleventName: string | symbol

                                Returns this

                                v0.1.26

                                -

                              • Removes the specified listener from the listener array for the event named eventName.

                                +

                              • Removes the specified listener from the listener array for the event named eventName.

                                const callback = (stream) => {
                                  console.log('someone connected!');
                                };
                                server.on('connection', callback);
                                // ...
                                server.removeListener('connection', callback);
                                @@ -250,7 +250,7 @@

                                Returns a reference to the EventEmitter, so that calls can be chained.

                                Type Parameters

                                • K

                                Parameters

                                • eventName: string | symbol
                                • listener: (...args: any[]) => void

                                Returns this

                                v0.1.26

                                -

                              • Called when socket is attached to request after being persisted because of +

                              • Called when socket is attached to request after being persisted because of the keep-alive options. Default behavior is to:

                                socket.ref();
                                @@ -258,13 +258,13 @@

                                This method can be overridden by a particular Agent subclass.

                                The socket argument can be an instance of net.Socket, a subclass of stream.Duplex.

                                Parameters

                                Returns void

                                v8.1.0

                                -

                              • By default EventEmitters will print a warning if more than 10 listeners are +

                              • By default EventEmitters will print a warning if more than 10 listeners are added for a particular event. This is a useful default that helps finding memory leaks. The emitter.setMaxListeners() method allows the limit to be modified for this specific EventEmitter instance. The value can be set to Infinity (or 0) to indicate an unlimited number of listeners.

                                Returns a reference to the EventEmitter, so that calls can be chained.

                                Parameters

                                • n: number

                                Returns this

                                v0.3.5

                                -

                              • Listens once to the abort event on the provided signal.

                                +

                              • Listens once to the abort event on the provided signal.

                                Listening to the abort event on abort signals is unsafe and may lead to resource leaks since another third party with the signal can call e.stopImmediatePropagation(). Unfortunately Node.js cannot change @@ -279,7 +279,7 @@

                                Parameters

                                Returns Disposable

                                Disposable that removes the abort listener.

                                v20.5.0

                                -

                              • Returns a copy of the array of listeners for the event named eventName.

                                +

                              • Returns a copy of the array of listeners for the event named eventName.

                                For EventEmitters this behaves exactly the same as calling .listeners on the emitter.

                                For EventTargets this is the only way to get the event listeners for the @@ -288,7 +288,7 @@

                                Parameters

                                Returns Function[]

                                v15.2.0, v14.17.0

                                -

                              • Returns the currently set max amount of listeners.

                                For EventEmitters this behaves exactly the same as calling .getMaxListeners on the emitter.

                                For EventTargets this is the only way to get the max event listeners for the @@ -298,15 +298,15 @@

                                Parameters

                                Returns number

                                v19.9.0

                                -

                              • A class method that returns the number of listeners for the given eventName registered on the given emitter.

                                +

                              • A class method that returns the number of listeners for the given eventName registered on the given emitter.

                                import { EventEmitter, listenerCount } from 'node:events';

                                const myEmitter = new EventEmitter();
                                myEmitter.on('event', () => {});
                                myEmitter.on('event', () => {});
                                console.log(listenerCount(myEmitter, 'event'));
                                // Prints: 2

                                Parameters

                                • emitter: EventEmitter

                                  The emitter to query

                                  -
                                • eventName: string | symbol

                                  The event name

                                  -

                                Returns number

                                v0.9.12

                                +
                              • eventName: string | symbol

                                The event name

                                +

                              Returns number

                              v0.9.12

                              Since v3.2.0 - Use listenerCount instead.

                              -
                              • import { on, EventEmitter } from 'node:events';
                                import process from 'node:process';

                                const ee = new EventEmitter();

                                // Emit later on
                                process.nextTick(() => {
                                  ee.emit('foo', 'bar');
                                  ee.emit('foo', 42);
                                });

                                for await (const event of on(ee, 'foo')) {
                                  // The execution of this inner block is synchronous and it
                                  // processes one event at a time (even with await). Do not use
                                  // if concurrent execution is required.
                                  console.log(event); // prints ['bar'] [42]
                                }
                                // Unreachable here
+
                              • import { on, EventEmitter } from 'node:events';
                                import process from 'node:process';

                                const ee = new EventEmitter();

                                // Emit later on
                                process.nextTick(() => {
                                  ee.emit('foo', 'bar');
                                  ee.emit('foo', 42);
                                });

                                for await (const event of on(ee, 'foo')) {
                                  // The execution of this inner block is synchronous and it
                                  // processes one event at a time (even with await). Do not use
                                  // if concurrent execution is required.
                                  console.log(event); // prints ['bar'] [42]
                                }
                                // Unreachable here

                                Returns an AsyncIterator that iterates eventName events. It will throw @@ -323,7 +323,7 @@

                                Parameters

                                Returns AsyncIterator<any[]>

                                An AsyncIterator that iterates eventName events emitted by the emitter

                                v13.6.0, v12.16.0

                                -
                              • import { on, EventEmitter } from 'node:events';
                                import process from 'node:process';

                                const ee = new EventEmitter();

                                // Emit later on
                                process.nextTick(() => {
                                  ee.emit('foo', 'bar');
                                  ee.emit('foo', 42);
                                });

                                for await (const event of on(ee, 'foo')) {
                                  // The execution of this inner block is synchronous and it
                                  // processes one event at a time (even with await). Do not use
                                  // if concurrent execution is required.
                                  console.log(event); // prints ['bar'] [42]
                                }
                                // Unreachable here
+
                              • import { on, EventEmitter } from 'node:events';
                                import process from 'node:process';

                                const ee = new EventEmitter();

                                // Emit later on
                                process.nextTick(() => {
                                  ee.emit('foo', 'bar');
                                  ee.emit('foo', 42);
                                });

                                for await (const event of on(ee, 'foo')) {
                                  // The execution of this inner block is synchronous and it
                                  // processes one event at a time (even with await). Do not use
                                  // if concurrent execution is required.
                                  console.log(event); // prints ['bar'] [42]
                                }
                                // Unreachable here

                                Returns an AsyncIterator that iterates eventName events. It will throw @@ -340,7 +340,7 @@

                                Parameters

                                Returns AsyncIterator<any[]>

                                An AsyncIterator that iterates eventName events emitted by the emitter

                                v13.6.0, v12.16.0

                                -

                              • Creates a Promise that is fulfilled when the EventEmitter emits the given +

                              • Creates a Promise that is fulfilled when the EventEmitter emits the given event or that is rejected if the EventEmitter emits 'error' while waiting. The Promise will resolve with an array of all the arguments emitted to the given event.

                                @@ -360,7 +360,7 @@

                                Parameters

                                Returns Promise<any[]>

                                v11.13.0, v10.16.0

                                -

                              • Creates a Promise that is fulfilled when the EventEmitter emits the given +

                              • Creates a Promise that is fulfilled when the EventEmitter emits the given event or that is rejected if the EventEmitter emits 'error' while waiting. The Promise will resolve with an array of all the arguments emitted to the given event.

                                @@ -380,11 +380,11 @@

                                Parameters

                                Returns Promise<any[]>

                                v11.13.0, v10.16.0

                                -
                              • import { setMaxListeners, EventEmitter } from 'node:events';

                                const target = new EventTarget();
                                const emitter = new EventEmitter();

                                setMaxListeners(5, target, emitter);
+
                              • import { setMaxListeners, EventEmitter } from 'node:events';

                                const target = new EventTarget();
                                const emitter = new EventEmitter();

                                setMaxListeners(5, target, emitter);

                                Parameters

                                • Optionaln: number

                                  A non-negative number. The maximum number of listeners per EventTarget event.

                                  -
                                • ...eventTargets: (EventEmitter<DefaultEventMap> | EventTarget)[]

                                  Zero or more {EventTarget} or {EventEmitter} instances. If none are specified, n is set as the default max for all newly created {EventTarget} and {EventEmitter} +

                                • ...eventTargets: (EventEmitter<DefaultEventMap> | EventTarget)[]

                                  Zero or more {EventTarget} or {EventEmitter} instances. If none are specified, n is set as the default max for all newly created {EventTarget} and {EventEmitter} objects.

                                  -

                                Returns void

                                v15.4.0

                                -

                              Settings

                              Member Visibility

                              On This Page

                              Constructors
                              Properties
                              Methods
                              +

                              Returns void

                              v15.4.0

                              +

                              Settings

                              Member Visibility

                              On This Page

                              Constructors
                              Properties
                              Methods
                              diff --git a/docs/classes/_internal_.Agent.html b/docs/classes/_internal_.Agent.html index e26b53f8..69aae835 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 @@ -76,34 +76,34 @@ on once setMaxListeners -

                              Constructors

                              Properties

                              freeSockets: ReadOnlyDict<Socket[]>

                              An object which contains arrays of sockets currently awaiting use by +

                              Constructors

                              Properties

                              freeSockets: ReadOnlyDict<Socket[]>

                              An object which contains arrays of sockets currently awaiting use by the agent when keepAlive is enabled. Do not modify.

                              Sockets in the freeSockets list will be automatically destroyed and removed from the array on 'timeout'.

                              v0.11.4

                              -
                              maxFreeSockets: number

                              By default set to 256. For agents with keepAlive enabled, this +

                              maxFreeSockets: number

                              By default set to 256. For agents with keepAlive enabled, this sets the maximum number of sockets that will be left open in the free state.

                              v0.11.7

                              -
                              maxSockets: number

                              By default set to Infinity. Determines how many concurrent sockets the agent +

                              maxSockets: number

                              By default set to Infinity. Determines how many concurrent sockets the agent can have open per origin. Origin is the returned value of agent.getName().

                              v0.3.6

                              -
                              maxTotalSockets: number

                              By default set to Infinity. Determines how many concurrent sockets the agent +

                              maxTotalSockets: number

                              By default set to Infinity. Determines how many concurrent sockets the agent can have open. Unlike maxSockets, this parameter applies across all origins.

                              v14.5.0, v12.19.0

                              -
                              requests: ReadOnlyDict<IncomingMessage[]>

                              An object which contains queues of requests that have not yet been assigned to +

                              requests: ReadOnlyDict<IncomingMessage[]>

                              An object which contains queues of requests that have not yet been assigned to sockets. Do not modify.

                              v0.5.9

                              -
                              sockets: ReadOnlyDict<Socket[]>

                              An object which contains arrays of sockets currently in use by the +

                              sockets: ReadOnlyDict<Socket[]>

                              An object which contains arrays of sockets currently in use by the agent. Do not modify.

                              v0.3.6

                              -
                              captureRejections: boolean

                              Value: boolean

                              +
                              captureRejections: boolean

                              Value: boolean

                              Change the default captureRejections option on all new EventEmitter objects.

                              v13.4.0, v12.16.0

                              -
                              captureRejectionSymbol: typeof captureRejectionSymbol

                              Value: Symbol.for('nodejs.rejection')

                              +
                              captureRejectionSymbol: typeof captureRejectionSymbol

                              Value: Symbol.for('nodejs.rejection')

                              See how to write a custom rejection handler.

                              v13.4.0, v12.16.0

                              -
                              defaultMaxListeners: number

                              By default, a maximum of 10 listeners can be registered for any single +

                              defaultMaxListeners: number

                              By default, a maximum of 10 listeners can be registered for any single event. This limit can be changed for individual EventEmitter instances using the emitter.setMaxListeners(n) method. To change the default for allEventEmitter instances, the events.defaultMaxListeners property @@ -128,13 +128,13 @@ listeners, respectively. Its name property is set to 'MaxListenersExceededWarning'.

                              v0.11.2

                              -
                              errorMonitor: typeof errorMonitor

                              This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

                              +
                              errorMonitor: typeof errorMonitor

                              This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

                              Installing a listener using this symbol does not change the behavior once an 'error' event is emitted. Therefore, the process will still crash if no regular 'error' listener is installed.

                              v13.6.0, v12.17.0

                              -

                              Methods

                              • Type Parameters

                                • K

                                Parameters

                                • error: Error
                                • event: string | symbol
                                • ...args: AnyRest

                                Returns void

                              • Alias for emitter.on(eventName, listener).

                                +

                              Methods

                              • Type Parameters

                                • K

                                Parameters

                                • error: Error
                                • event: string | symbol
                                • ...args: AnyRest

                                Returns void

                              • Alias for emitter.on(eventName, listener).

                                Type Parameters

                                • K

                                Parameters

                                • eventName: string | symbol
                                • listener: (...args: any[]) => void

                                Returns this

                                v0.1.26

                                -

                              • Produces a socket/stream to be used for HTTP requests.

                                +

                              • Produces a socket/stream to be used for HTTP requests.

                                By default, this function is the same as net.createConnection(). However, custom agents may override this method in case greater flexibility is desired.

                                A socket/stream can be supplied in one of two ways: by returning the @@ -144,38 +144,38 @@ type other than net.Socket.

                                callback has a signature of (err, stream).

                                Parameters

                                • options: ClientRequestArgs

                                  Options containing connection details. Check createConnection for the format of the options

                                  -
                                • Optionalcallback: (err: Error, stream: Duplex) => void

                                  Callback function that receives the created socket

                                  -

                                Returns Duplex

                                v0.11.4

                                -

                              • Destroy any sockets that are currently in use by the agent.

                                +
                              • Optionalcallback: (err: Error, stream: Duplex) => void

                                Callback function that receives the created socket

                                +

                              Returns Duplex

                              v0.11.4

                              +

                              • Destroy any sockets that are currently in use by the agent.

                                It is usually not necessary to do this. However, if using an agent with keepAlive enabled, then it is best to explicitly shut down the agent when it is no longer needed. Otherwise, sockets might stay open for quite a long time before the server terminates them.

                                Returns void

                                v0.11.4

                                -

                              • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments +

                              • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

                                Returns true if the event had listeners, false otherwise.

                                import { EventEmitter } from 'node:events';
                                const myEmitter = new EventEmitter();

                                // First listener
                                myEmitter.on('event', function firstListener() {
                                  console.log('Helloooo! first listener');
                                });
                                // Second listener
                                myEmitter.on('event', function secondListener(arg1, arg2) {
                                  console.log(`event with parameters ${arg1}, ${arg2} in second listener`);
                                });
                                // Third listener
                                myEmitter.on('event', function thirdListener(...args) {
                                  const parameters = args.join(', ');
                                  console.log(`event with parameters ${parameters} in third listener`);
                                });

                                console.log(myEmitter.listeners('event'));

                                myEmitter.emit('event', 1, 2, 3, 4, 5);

                                // Prints:
                                // [
                                //   [Function: firstListener],
                                //   [Function: secondListener],
                                //   [Function: thirdListener]
                                // ]
                                // Helloooo! first listener
                                // event with parameters 1, 2 in second listener
                                // event with parameters 1, 2, 3, 4, 5 in third listener

                                Type Parameters

                                • K

                                Parameters

                                • eventName: string | symbol
                                • ...args: AnyRest

                                Returns boolean

                                v0.1.26

                                -

                              • Returns an array listing the events for which the emitter has registered +

                              • Returns an array listing the events for which the emitter has registered listeners. The values in the array are strings or Symbols.

                                import { EventEmitter } from 'node:events';

                                const myEE = new EventEmitter();
                                myEE.on('foo', () => {});
                                myEE.on('bar', () => {});

                                const sym = Symbol('symbol');
                                myEE.on(sym, () => {});

                                console.log(myEE.eventNames());
                                // Prints: [ 'foo', 'bar', Symbol(symbol) ]

                                Returns (string | symbol)[]

                                v6.0.0

                                -

                              • Returns the current max listener value for the EventEmitter which is either +

                              • Returns the current max listener value for the EventEmitter which is either set by emitter.setMaxListeners(n) or defaults to EventEmitter.defaultMaxListeners.

                                Returns number

                                v1.0.0

                                -

                              • Get a unique name for a set of request options, to determine whether a connection can be reused. For an HTTP agent, this returnshost:port:localAddress or host:port:localAddress:family. For an HTTPS agent, the name includes the CA, cert, ciphers, and other HTTPS/TLS-specific options that determine socket reusability.

                                Parameters

                                • Optionaloptions: ClientRequestArgs

                                  A set of options providing information for name generation

                                  -

                                Returns string

                                v0.11.4

                                -

                              • Called when socket is detached from a request and could be persisted by theAgent. Default behavior is to:

                                +

                              Returns string

                              v0.11.4

                              +

                              • Called when socket is detached from a request and could be persisted by theAgent. Default behavior is to:

                                socket.setKeepAlive(true, this.keepAliveMsecs);
                                socket.unref();
                                return true;
                                @@ -184,20 +184,20 @@ it for use with the next request.

                                The socket argument can be an instance of net.Socket, a subclass of stream.Duplex.

                                Parameters

                                Returns void

                                v8.1.0

                                -

                              • Returns the number of listeners listening for the event named eventName. +

                              • Returns the number of listeners listening for the event named eventName. If listener is provided, it will return how many times the listener is found in the list of the listeners of the event.

                                Type Parameters

                                • K

                                Parameters

                                • eventName: string | symbol

                                  The name of the event being listened for

                                  -
                                • Optionallistener: Function

                                  The event handler function

                                  -

                                Returns number

                                v3.2.0

                                -

                              • Returns a copy of the array of listeners for the event named eventName.

                                +
                              • Optionallistener: Function

                                The event handler function

                                +

                              Returns number

                              v3.2.0

                              +

                              • Returns a copy of the array of listeners for the event named eventName.

                                server.on('connection', (stream) => {
                                  console.log('someone connected!');
                                });
                                console.log(util.inspect(server.listeners('connection')));
                                // Prints: [ [Function] ]

                                Type Parameters

                                • K

                                Parameters

                                • eventName: string | symbol

                                Returns Function[]

                                v0.1.26

                                -

                              • Alias for emitter.removeListener().

                                +

                              • Alias for emitter.removeListener().

                                Type Parameters

                                • K

                                Parameters

                                • eventName: string | symbol
                                • listener: (...args: any[]) => void

                                Returns this

                                v10.0.0

                                -

                              • Adds the listener function to the end of the listeners array for the event +

                              • Adds the listener function to the end of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.

                                @@ -211,9 +211,9 @@

                                Type Parameters

                                • K

                                Parameters

                                • eventName: string | symbol

                                  The name of the event.

                                  -
                                • listener: (...args: any[]) => void

                                  The callback function

                                  -

                                Returns this

                                v0.1.101

                                -

                              • Adds a one-time listener function for the event named eventName. The +

                              • listener: (...args: any[]) => void

                                The callback function

                                +

                              Returns this

                              v0.1.101

                              +

                              • Adds a one-time listener function for the event named eventName. The next time eventName is triggered, this listener is removed and then invoked.

                                server.once('connection', (stream) => {
                                  console.log('Ah, we have our first user!');
                                });
                                @@ -225,9 +225,9 @@

                                Type Parameters

                                • K

                                Parameters

                                • eventName: string | symbol

                                  The name of the event.

                                  -
                                • listener: (...args: any[]) => void

                                  The callback function

                                  -

                                Returns this

                                v0.3.0

                                -

                              • Adds the listener function to the beginning of the listeners array for the +

                              • listener: (...args: any[]) => void

                                The callback function

                                +

                              Returns this

                              v0.3.0

                              +

                              • Adds the listener function to the beginning of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.

                                @@ -236,30 +236,30 @@

                                Returns a reference to the EventEmitter, so that calls can be chained.

                                Type Parameters

                                • K

                                Parameters

                                • eventName: string | symbol

                                  The name of the event.

                                  -
                                • listener: (...args: any[]) => void

                                  The callback function

                                  -

                                Returns this

                                v6.0.0

                                -

                              • Adds a one-timelistener function for the event named eventName to the beginning of the listeners array. The next time eventName is triggered, this +

                              • listener: (...args: any[]) => void

                                The callback function

                                +

                              Returns this

                              v6.0.0

                              +

                              • Adds a one-timelistener function for the event named eventName to the beginning of the listeners array. The next time eventName is triggered, this listener is removed, and then invoked.

                                server.prependOnceListener('connection', (stream) => {
                                  console.log('Ah, we have our first user!');
                                });

                                Returns a reference to the EventEmitter, so that calls can be chained.

                                Type Parameters

                                • K

                                Parameters

                                • eventName: string | symbol

                                  The name of the event.

                                  -
                                • listener: (...args: any[]) => void

                                  The callback function

                                  -

                                Returns this

                                v6.0.0

                                -

                              • Returns a copy of the array of listeners for the event named eventName, +

                              • listener: (...args: any[]) => void

                                The callback function

                                +

                              Returns this

                              v6.0.0

                              +

                              • Returns a copy of the array of listeners for the event named eventName, including any wrappers (such as those created by .once()).

                                import { EventEmitter } from 'node:events';
                                const emitter = new EventEmitter();
                                emitter.once('log', () => console.log('log once'));

                                // Returns a new Array with a function `onceWrapper` which has a property
                                // `listener` which contains the original listener bound above
                                const listeners = emitter.rawListeners('log');
                                const logFnWrapper = listeners[0];

                                // Logs "log once" to the console and does not unbind the `once` event
                                logFnWrapper.listener();

                                // Logs "log once" to the console and removes the listener
                                logFnWrapper();

                                emitter.on('log', () => console.log('log persistently'));
                                // Will return a new Array with a single function bound by `.on()` above
                                const newListeners = emitter.rawListeners('log');

                                // Logs "log persistently" twice
                                newListeners[0]();
                                emitter.emit('log');

                                Type Parameters

                                • K

                                Parameters

                                • eventName: string | symbol

                                Returns Function[]

                                v9.4.0

                                -

                              • Removes all listeners, or those of the specified eventName.

                                +

                              • Removes all listeners, or those of the specified eventName.

                                It is bad practice to remove listeners added elsewhere in the code, particularly when the EventEmitter instance was created by some other component or module (e.g. sockets or file streams).

                                Returns a reference to the EventEmitter, so that calls can be chained.

                                Parameters

                                • OptionaleventName: string | symbol

                                Returns this

                                v0.1.26

                                -

                              • Removes the specified listener from the listener array for the event named eventName.

                                +

                              • Removes the specified listener from the listener array for the event named eventName.

                                const callback = (stream) => {
                                  console.log('someone connected!');
                                };
                                server.on('connection', callback);
                                // ...
                                server.removeListener('connection', callback);
                                @@ -286,7 +286,7 @@

                                Returns a reference to the EventEmitter, so that calls can be chained.

                                Type Parameters

                                • K

                                Parameters

                                • eventName: string | symbol
                                • listener: (...args: any[]) => void

                                Returns this

                                v0.1.26

                                -

                              • Called when socket is attached to request after being persisted because of +

                              • Called when socket is attached to request after being persisted because of the keep-alive options. Default behavior is to:

                                socket.ref();
                                @@ -294,13 +294,13 @@

                                This method can be overridden by a particular Agent subclass.

                                The socket argument can be an instance of net.Socket, a subclass of stream.Duplex.

                                Parameters

                                Returns void

                                v8.1.0

                                -

                              • By default EventEmitters will print a warning if more than 10 listeners are +

                              • By default EventEmitters will print a warning if more than 10 listeners are added for a particular event. This is a useful default that helps finding memory leaks. The emitter.setMaxListeners() method allows the limit to be modified for this specific EventEmitter instance. The value can be set to Infinity (or 0) to indicate an unlimited number of listeners.

                                Returns a reference to the EventEmitter, so that calls can be chained.

                                Parameters

                                • n: number

                                Returns this

                                v0.3.5

                                -

                              • Listens once to the abort event on the provided signal.

                                +

                              • Listens once to the abort event on the provided signal.

                                Listening to the abort event on abort signals is unsafe and may lead to resource leaks since another third party with the signal can call e.stopImmediatePropagation(). Unfortunately Node.js cannot change @@ -315,7 +315,7 @@

                                Parameters

                                Returns Disposable

                                Disposable that removes the abort listener.

                                v20.5.0

                                -

                              • Returns a copy of the array of listeners for the event named eventName.

                                For EventEmitters this behaves exactly the same as calling .listeners on the emitter.

                                For EventTargets this is the only way to get the event listeners for the @@ -324,7 +324,7 @@

                                Parameters

                                Returns Function[]

                                v15.2.0, v14.17.0

                                -

                              • A class method that returns the number of listeners for the given eventName registered on the given emitter.

                                +

                              • A class method that returns the number of listeners for the given eventName registered on the given emitter.

                                import { EventEmitter, listenerCount } from 'node:events';

                                const myEmitter = new EventEmitter();
                                myEmitter.on('event', () => {});
                                myEmitter.on('event', () => {});
                                console.log(listenerCount(myEmitter, 'event'));
                                // Prints: 2

                                Parameters

                                • emitter: EventEmitter

                                  The emitter to query

                                  -
                                • eventName: string | symbol

                                  The event name

                                  -

                                Returns number

                                v0.9.12

                                +
                              • eventName: string | symbol

                                The event name

                                +

                              Returns number

                              v0.9.12

                              Since v3.2.0 - Use listenerCount instead.

                              -
                              • import { on, EventEmitter } from 'node:events';
                                import process from 'node:process';

                                const ee = new EventEmitter();

                                // Emit later on
                                process.nextTick(() => {
                                  ee.emit('foo', 'bar');
                                  ee.emit('foo', 42);
                                });

                                for await (const event of on(ee, 'foo')) {
                                  // The execution of this inner block is synchronous and it
                                  // processes one event at a time (even with await). Do not use
                                  // if concurrent execution is required.
                                  console.log(event); // prints ['bar'] [42]
                                }
                                // Unreachable here
+
                              • import { on, EventEmitter } from 'node:events';
                                import process from 'node:process';

                                const ee = new EventEmitter();

                                // Emit later on
                                process.nextTick(() => {
                                  ee.emit('foo', 'bar');
                                  ee.emit('foo', 42);
                                });

                                for await (const event of on(ee, 'foo')) {
                                  // The execution of this inner block is synchronous and it
                                  // processes one event at a time (even with await). Do not use
                                  // if concurrent execution is required.
                                  console.log(event); // prints ['bar'] [42]
                                }
                                // Unreachable here

                                Returns an AsyncIterator that iterates eventName events. It will throw @@ -359,7 +359,7 @@

                                Parameters

                                Returns AsyncIterator<any[]>

                                An AsyncIterator that iterates eventName events emitted by the emitter

                                v13.6.0, v12.16.0

                                -
                              • import { on, EventEmitter } from 'node:events';
                                import process from 'node:process';

                                const ee = new EventEmitter();

                                // Emit later on
                                process.nextTick(() => {
                                  ee.emit('foo', 'bar');
                                  ee.emit('foo', 42);
                                });

                                for await (const event of on(ee, 'foo')) {
                                  // The execution of this inner block is synchronous and it
                                  // processes one event at a time (even with await). Do not use
                                  // if concurrent execution is required.
                                  console.log(event); // prints ['bar'] [42]
                                }
                                // Unreachable here
+
                              • import { on, EventEmitter } from 'node:events';
                                import process from 'node:process';

                                const ee = new EventEmitter();

                                // Emit later on
                                process.nextTick(() => {
                                  ee.emit('foo', 'bar');
                                  ee.emit('foo', 42);
                                });

                                for await (const event of on(ee, 'foo')) {
                                  // The execution of this inner block is synchronous and it
                                  // processes one event at a time (even with await). Do not use
                                  // if concurrent execution is required.
                                  console.log(event); // prints ['bar'] [42]
                                }
                                // Unreachable here

                                Returns an AsyncIterator that iterates eventName events. It will throw @@ -376,7 +376,7 @@

                                Parameters

                                Returns AsyncIterator<any[]>

                                An AsyncIterator that iterates eventName events emitted by the emitter

                                v13.6.0, v12.16.0

                                -

                              • Creates a Promise that is fulfilled when the EventEmitter emits the given +

                              • Creates a Promise that is fulfilled when the EventEmitter emits the given event or that is rejected if the EventEmitter emits 'error' while waiting. The Promise will resolve with an array of all the arguments emitted to the given event.

                                @@ -396,7 +396,7 @@

                                Parameters

                                Returns Promise<any[]>

                                v11.13.0, v10.16.0

                                -

                              • Creates a Promise that is fulfilled when the EventEmitter emits the given +

                              • Creates a Promise that is fulfilled when the EventEmitter emits the given event or that is rejected if the EventEmitter emits 'error' while waiting. The Promise will resolve with an array of all the arguments emitted to the given event.

                                @@ -416,11 +416,11 @@

                                Parameters

                                Returns Promise<any[]>

                                v11.13.0, v10.16.0

                                -
                              • import { setMaxListeners, EventEmitter } from 'node:events';

                                const target = new EventTarget();
                                const emitter = new EventEmitter();

                                setMaxListeners(5, target, emitter);
+
                              • import { setMaxListeners, EventEmitter } from 'node:events';

                                const target = new EventTarget();
                                const emitter = new EventEmitter();

                                setMaxListeners(5, target, emitter);

                                Parameters

                                • Optionaln: number

                                  A non-negative number. The maximum number of listeners per EventTarget event.

                                  -
                                • ...eventTargets: (EventEmitter<DefaultEventMap> | EventTarget)[]

                                  Zero or more {EventTarget} or {EventEmitter} instances. If none are specified, n is set as the default max for all newly created {EventTarget} and {EventEmitter} +

                                • ...eventTargets: (EventEmitter<DefaultEventMap> | EventTarget)[]

                                  Zero or more {EventTarget} or {EventEmitter} instances. If none are specified, n is set as the default max for all newly created {EventTarget} and {EventEmitter} objects.

                                  -

                                Returns void

                                v15.4.0

                                -

                              Settings

                              Member Visibility

                              On This Page

                              Constructors
                              Properties
                              Methods
                              +

                              Returns void

                              v15.4.0

                              +

                              Settings

                              Member Visibility

                              On This Page

                              Constructors
                              Properties
                              Methods
                              diff --git a/docs/classes/_internal_.Alias.html b/docs/classes/_internal_.Alias.html index 0c7caf71..cb50a708 100644 --- a/docs/classes/_internal_.Alias.html +++ b/docs/classes/_internal_.Alias.html @@ -1,4 +1,4 @@ -Alias | ts-lambda-api - v2.5.2
                              ts-lambda-api - v2.5.2
                                Preparing search index...

                                Class Alias

                                Hierarchy (View Summary)

                                Index

                                Constructors

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

                                  Class Alias

                                  Hierarchy (View Summary)

                                  Index

                                  Constructors

                                  constructor

                                  Properties

                                  [NODE_TYPE] addToJSMap? anchor? @@ -16,18 +16,18 @@ toString

                                  Constructors

                                  • Parameters

                                    • source: string

                                    Returns Alias

                                  Properties

                                  "[NODE_TYPE]": symbol
                                  addToJSMap?: (ctx: ToJSContext, map: MapLike, value: unknown) => void

                                  Customize the way that a key-value pair is resolved. Used for YAML 1.1 !!merge << handling.

                                  -
                                  anchor?: never
                                  comment?: string

                                  A comment on or immediately after this

                                  -
                                  commentBefore?: string

                                  A comment before this

                                  -
                                  range?: Range

                                  The [start, value-end, node-end] character offsets for the part of the +

                                  anchor?: never
                                  comment?: string

                                  A comment on or immediately after this

                                  +
                                  commentBefore?: string

                                  A comment before this

                                  +
                                  range?: Range

                                  The [start, value-end, node-end] character offsets for the part of the source parsed into this node (undefined if not parsed). The value-end and node-end positions are themselves not included in their respective ranges.

                                  -
                                  source: string
                                  spaceBefore?: boolean

                                  A blank line before this node and its commentBefore

                                  -
                                  srcToken?: Token

                                  The CST token that was composed into this node.

                                  -
                                  tag?: string

                                  A fully qualified tag, if required

                                  -

                                  Methods

                                  • Resolve the value of this alias within doc, finding the last +

                                  source: string
                                  spaceBefore?: boolean

                                  A blank line before this node and its commentBefore

                                  +
                                  srcToken?: Token

                                  The CST token that was composed into this node.

                                  +
                                  tag?: string

                                  A fully qualified tag, if required

                                  +

                                  Methods

                                  • Resolve the value of this alias within doc, finding the last instance of the source anchor before this node.

                                    -

                                    Parameters

                                    Returns Scalar<unknown> | YAMLMap<unknown, unknown> | YAMLSeq<unknown>

                                  • A plain JavaScript representation of this node.

                                    -

                                    Parameters

                                    Returns any

                                  • A plain JS representation of this node

                                    -

                                    Parameters

                                    Returns unknown

                                  • Parameters

                                    • Optionalctx: StringifyContext
                                    • Optional_onComment: () => void
                                    • Optional_onChompKeep: () => void

                                    Returns string

                                  Settings

                                  Member Visibility

                                  On This Page

                                  Constructors
                                  Properties
                                  Methods
                                  +

                                  Parameters

                                  Returns Scalar<unknown> | YAMLMap<unknown, unknown> | YAMLSeq<unknown>

                                  • A plain JavaScript representation of this node.

                                    +

                                    Parameters

                                    Returns any

                                  • A plain JS representation of this node

                                    +

                                    Parameters

                                    Returns unknown

                                  • Parameters

                                    • Optionalctx: StringifyContext
                                    • Optional_onComment: () => void
                                    • Optional_onChompKeep: () => void

                                    Returns string

                                  Settings

                                  Member Visibility

                                  On This Page

                                  Constructors
                                  Properties
                                  Methods
                                  diff --git a/docs/classes/_internal_.ApiBody.html b/docs/classes/_internal_.ApiBody.html index f9f64e6c..6d0e5cf4 100644 --- a/docs/classes/_internal_.ApiBody.html +++ b/docs/classes/_internal_.ApiBody.html @@ -1,5 +1,5 @@ ApiBody | ts-lambda-api - v2.5.2
                                  ts-lambda-api - v2.5.2
                                    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 6342de35..6945e8bc 100644 --- a/docs/classes/_internal_.ApiBodyInfo.html +++ b/docs/classes/_internal_.ApiBodyInfo.html @@ -1,5 +1,5 @@ ApiBodyInfo | ts-lambda-api - v2.5.2
                                    ts-lambda-api - v2.5.2
                                      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 68e1c330..cee812fb 100644 --- a/docs/classes/_internal_.ApiOperation.html +++ b/docs/classes/_internal_.ApiOperation.html @@ -1,14 +1,14 @@ ApiOperation | ts-lambda-api - v2.5.2
                                      ts-lambda-api - v2.5.2
                                        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 cf248ca0..d2635b9d 100644 --- a/docs/classes/_internal_.ApiOperationInfo.html +++ b/docs/classes/_internal_.ApiOperationInfo.html @@ -1,5 +1,5 @@ ApiOperationInfo | ts-lambda-api - v2.5.2
                                        ts-lambda-api - v2.5.2
                                          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 e79914d6..e013fe17 100644 --- a/docs/classes/_internal_.ApiParam.html +++ b/docs/classes/_internal_.ApiParam.html @@ -1,5 +1,5 @@ ApiParam | ts-lambda-api - v2.5.2
                                          ts-lambda-api - v2.5.2
                                            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 dab3e860..708265d0 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 @@ -17,29 +17,29 @@ new AsyncResource() also triggers init. If triggerAsyncId is omitted then async_hook.executionAsyncId() is used.

                                            Parameters

                                            • type: string

                                              The type of async event.

                                              -
                                            • OptionaltriggerAsyncId: number | AsyncResourceOptions

                                              The ID of the execution context that created +

                                            • OptionaltriggerAsyncId: number | AsyncResourceOptions

                                              The ID of the execution context that created this async event (default: executionAsyncId()), or an AsyncResourceOptions object (since v9.3.0)

                                              -

                                            Returns AsyncResource

                                            Methods

                                            • Returns number

                                              The unique asyncId assigned to the resource.

                                              -

                                            • Binds the given function to execute to this AsyncResource's scope.

                                              +

                                            Returns AsyncResource

                                            Methods

                                            • Returns number

                                              The unique asyncId assigned to the resource.

                                              +

                                            • Binds the given function to execute to this AsyncResource's scope.

                                              Type Parameters

                                              • Func extends (...args: any[]) => any

                                              Parameters

                                              • fn: Func

                                                The function to bind to the current AsyncResource.

                                                -

                                              Returns Func

                                              v14.8.0, v12.19.0

                                              +

                                            Returns Func

                                            v14.8.0, v12.19.0

                                            • Call all destroy hooks. This should only ever be called once. An error will be thrown if it is called more than once. This must be manually called. If the resource is left to be collected by the GC then the destroy hooks will never be called.

                                              Returns this

                                              A reference to asyncResource.

                                              -

                                            • Call the provided function with the provided arguments in the execution context +

                                            • Call the provided function with the provided arguments in the execution context of the async resource. This will establish the context, trigger the AsyncHooks before callbacks, call the function, trigger the AsyncHooks after callbacks, and then restore the original execution context.

                                              Type Parameters

                                              • This
                                              • Result

                                              Parameters

                                              • fn: (this: This, ...args: any[]) => Result

                                                The function to call in the execution context of this async resource.

                                                -
                                              • OptionalthisArg: This

                                                The receiver to be used for the function call.

                                                -
                                              • ...args: any[]

                                                Optional arguments to pass to the function.

                                                -

                                              Returns Result

                                              v9.6.0

                                              +
                                            • OptionalthisArg: This

                                              The receiver to be used for the function call.

                                              +
                                            • ...args: any[]

                                              Optional arguments to pass to the function.

                                              +

                                            Returns Result

                                            v9.6.0

                                            • Returns number

                                              The same triggerAsyncId that is passed to the AsyncResource constructor.

                                              -

                                            • Binds the given function to the current execution context.

                                              +

                                            • Binds the given function to the current execution context.

                                              Type Parameters

                                              • Func extends (this: ThisArg, ...args: any[]) => any
                                              • ThisArg

                                              Parameters

                                              • fn: Func

                                                The function to bind to the current execution context.

                                                -
                                              • Optionaltype: string

                                                An optional name to associate with the underlying AsyncResource.

                                                -
                                              • OptionalthisArg: ThisArg

                                              Returns Func

                                              v14.8.0, v12.19.0

                                              +
                                            • Optionaltype: string

                                              An optional name to associate with the underlying AsyncResource.

                                              +
                                            • OptionalthisArg: ThisArg

                                            Returns Func

                                            v14.8.0, v12.19.0

                                            Settings

                                            Member Visibility

                                            On This Page

                                            Constructors
                                            Methods
                                            diff --git a/docs/classes/_internal_.Blob.html b/docs/classes/_internal_.Blob.html index cf54a3d1..3121d2f8 100644 --- a/docs/classes/_internal_.Blob.html +++ b/docs/classes/_internal_.Blob.html @@ -1,7 +1,7 @@ -Blob | ts-lambda-api - v2.5.2
                                            ts-lambda-api - v2.5.2
                                              Preparing search index...

                                              Class Blob

                                              A Blob encapsulates immutable, raw data that can be safely shared across +Blob | ts-lambda-api - v2.5.2

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

                                                Class Blob

                                                A Blob encapsulates immutable, raw data that can be safely shared across multiple worker threads.

                                                v15.7.0, v14.18.0

                                                -
                                                Index

                                                Constructors

                                                constructor +
                                                Index

                                                Constructors

                                                constructor

                                                Properties

                                                size type

                                                Methods

                                                arrayBuffer @@ -13,26 +13,26 @@

                                                {ArrayBuffer}, {TypedArray}, {DataView}, and {Buffer} sources are copied into the 'Blob' and can therefore be safely modified after the 'Blob' is created.

                                                String sources are also copied into the Blob.

                                                -

                                                Parameters

                                                Returns Blob

                                                Properties

                                                size: number

                                                The total size of the Blob in bytes.

                                                +

                                                Parameters

                                                Returns Blob

                                                Properties

                                                size: number

                                                The total size of the Blob in bytes.

                                                v15.7.0, v14.18.0

                                                -
                                                type: string

                                                The content-type of the Blob.

                                                +
                                                type: string

                                                The content-type of the Blob.

                                                v15.7.0, v14.18.0

                                                -

                                                Methods

                                                • Returns a promise that fulfills with an ArrayBuffer containing a copy of +

                                                Methods

                                                • Returns a promise that fulfills with an ArrayBuffer containing a copy of the Blob data.

                                                  Returns Promise<ArrayBuffer>

                                                  v15.7.0, v14.18.0

                                                  -

                                                • The blob.bytes() method returns the byte of the Blob object as a Promise<Uint8Array>.

                                                  +

                                                • The blob.bytes() method returns the byte of the Blob object as a Promise<Uint8Array>.

                                                  const blob = new Blob(['hello']);
                                                  blob.bytes().then((bytes) => {
                                                    console.log(bytes); // Outputs: Uint8Array(5) [ 104, 101, 108, 108, 111 ]
                                                  });
                                                  -

                                                  Returns Promise<Uint8Array<ArrayBufferLike>>

                                                • Creates and returns a new Blob containing a subset of this Blob objects +

                                                  Returns Promise<Uint8Array<ArrayBufferLike>>

                                                • Creates and returns a new Blob containing a subset of this Blob objects data. The original Blob is not altered.

                                                  Parameters

                                                  • Optionalstart: number

                                                    The starting index.

                                                    -
                                                  • Optionalend: number

                                                    The ending index.

                                                    -
                                                  • Optionaltype: string

                                                    The content-type for the new Blob

                                                    -

                                                  Returns Blob

                                                  v15.7.0, v14.18.0

                                                  -

                                                • Returns a new ReadableStream that allows the content of the Blob to be read.

                                                  +
                                                • Optionalend: number

                                                  The ending index.

                                                  +
                                                • Optionaltype: string

                                                  The content-type for the new Blob

                                                  +

                                                Returns Blob

                                                v15.7.0, v14.18.0

                                                +

                                                • Returns a new ReadableStream that allows the content of the Blob to be read.

                                                  Returns ReadableStream

                                                  v16.7.0

                                                  -

                                                text

                                                • text(): Promise<string>

                                                  Returns a promise that fulfills with the contents of the Blob decoded as a +

                                                text

                                                • text(): Promise<string>

                                                  Returns a promise that fulfills with the contents of the Blob decoded as a UTF-8 string.

                                                  Returns Promise<string>

                                                  v15.7.0, v14.18.0

                                                  -

                                                Settings

                                                Member Visibility

                                                On This Page

                                                Constructors
                                                Properties
                                                Methods
                                                +

                                                Settings

                                                Member Visibility

                                                On This Page

                                                Constructors
                                                Properties
                                                Methods
                                                diff --git a/docs/classes/_internal_.BlockList.html b/docs/classes/_internal_.BlockList.html index 744fde8c..5f3dcaa4 100644 --- a/docs/classes/_internal_.BlockList.html +++ b/docs/classes/_internal_.BlockList.html @@ -2,54 +2,61 @@ disabling inbound or outbound access to specific IP addresses, IP ranges, or IP subnets.

                                                v15.0.0, v14.18.0

                                                -
                                                Index

                                                Constructors

                                                constructor +
                                                Index

                                                Constructors

                                                constructor

                                                Properties

                                                rules

                                                Methods

                                                addAddress addRange addSubnet check +fromJSON +toJSON isBlockList

                                                Constructors

                                                Properties

                                                rules: readonly string[]

                                                The list of rules added to the blocklist.

                                                v15.0.0, v14.18.0

                                                -

                                                Methods

                                                • Adds a rule to block the given IP address.

                                                  +

                                                Methods

                                                • Adds a rule to block the given IP address.

                                                  Parameters

                                                  • address: string

                                                    An IPv4 or IPv6 address.

                                                    -
                                                  • Optionaltype: IPVersion

                                                    Either 'ipv4' or 'ipv6'.

                                                    -

                                                  Returns void

                                                  v15.0.0, v14.18.0

                                                  -

                                                • Adds a rule to block the given IP address.

                                                  +
                                                • Optionaltype: IPVersion

                                                  Either 'ipv4' or 'ipv6'.

                                                  +

                                                Returns void

                                                v15.0.0, v14.18.0

                                                +

                                              • Adds a rule to block the given IP address.

                                                Parameters

                                                Returns void

                                                v15.0.0, v14.18.0

                                                -

                                                • Adds a rule to block a range of IP addresses from start (inclusive) toend (inclusive).

                                                  +

                                                Returns void

                                                v15.0.0, v14.18.0

                                                +

                                                • Adds a rule to block a range of IP addresses from start (inclusive) toend (inclusive).

                                                  Parameters

                                                  • start: string

                                                    The starting IPv4 or IPv6 address in the range.

                                                    -
                                                  • end: string

                                                    The ending IPv4 or IPv6 address in the range.

                                                    -
                                                  • Optionaltype: IPVersion

                                                    Either 'ipv4' or 'ipv6'.

                                                    -

                                                  Returns void

                                                  v15.0.0, v14.18.0

                                                  -

                                                • Adds a rule to block a range of IP addresses from start (inclusive) toend (inclusive).

                                                  +
                                                • end: string

                                                  The ending IPv4 or IPv6 address in the range.

                                                  +
                                                • Optionaltype: IPVersion

                                                  Either 'ipv4' or 'ipv6'.

                                                  +

                                                Returns void

                                                v15.0.0, v14.18.0

                                                +

                                              • Adds a rule to block a range of IP addresses from start (inclusive) toend (inclusive).

                                                Parameters

                                                • start: SocketAddress

                                                  The starting IPv4 or IPv6 address in the range.

                                                  -
                                                • end: SocketAddress

                                                  The ending IPv4 or IPv6 address in the range.

                                                  -

                                                Returns void

                                                v15.0.0, v14.18.0

                                                -

                                                • Adds a rule to block a range of IP addresses specified as a subnet mask.

                                                  +
                                                • end: SocketAddress

                                                  The ending IPv4 or IPv6 address in the range.

                                                  +

                                                Returns void

                                                v15.0.0, v14.18.0

                                                +

                                                • Adds a rule to block a range of IP addresses specified as a subnet mask.

                                                  Parameters

                                                  • net: SocketAddress

                                                    The network IPv4 or IPv6 address.

                                                    -
                                                  • prefix: number

                                                    The number of CIDR prefix bits. For IPv4, this must be a value between 0 and 32. For IPv6, this must be between 0 and 128.

                                                    -

                                                  Returns void

                                                  v15.0.0, v14.18.0

                                                  -

                                                • Adds a rule to block a range of IP addresses specified as a subnet mask.

                                                  +
                                                • prefix: number

                                                  The number of CIDR prefix bits. For IPv4, this must be a value between 0 and 32. For IPv6, this must be between 0 and 128.

                                                  +

                                                Returns void

                                                v15.0.0, v14.18.0

                                                +

                                              • Adds a rule to block a range of IP addresses specified as a subnet mask.

                                                Parameters

                                                • net: string

                                                  The network IPv4 or IPv6 address.

                                                  -
                                                • prefix: number

                                                  The number of CIDR prefix bits. For IPv4, this must be a value between 0 and 32. For IPv6, this must be between 0 and 128.

                                                  -
                                                • Optionaltype: IPVersion

                                                  Either 'ipv4' or 'ipv6'.

                                                  -

                                                Returns void

                                                v15.0.0, v14.18.0

                                                -

                                                • Returns true if the given IP address matches any of the rules added to theBlockList.

                                                  +
                                                • prefix: number

                                                  The number of CIDR prefix bits. For IPv4, this must be a value between 0 and 32. For IPv6, this must be between 0 and 128.

                                                  +
                                                • Optionaltype: IPVersion

                                                  Either 'ipv4' or 'ipv6'.

                                                  +

                                                Returns void

                                                v15.0.0, v14.18.0

                                                +

                                                • Returns true if the given IP address matches any of the rules added to theBlockList.

                                                  const blockList = new net.BlockList();
                                                  blockList.addAddress('123.123.123.123');
                                                  blockList.addRange('10.0.0.1', '10.0.0.10');
                                                  blockList.addSubnet('8592:757c:efae:4e45::', 64, 'ipv6');

                                                  console.log(blockList.check('123.123.123.123'));  // Prints: true
                                                  console.log(blockList.check('10.0.0.3'));  // Prints: true
                                                  console.log(blockList.check('222.111.111.222'));  // Prints: false

                                                  // IPv6 notation for IPv4 addresses works:
                                                  console.log(blockList.check('::ffff:7b7b:7b7b', 'ipv6')); // Prints: true
                                                  console.log(blockList.check('::ffff:123.123.123.123', 'ipv6')); // Prints: true

                                                  Parameters

                                                  Returns boolean

                                                  v15.0.0, v14.18.0

                                                  -

                                                • Returns true if the given IP address matches any of the rules added to theBlockList.

                                                  +

                                                Returns boolean

                                                v15.0.0, v14.18.0

                                                +

                                              • Returns true if the given IP address matches any of the rules added to theBlockList.

                                                const blockList = new net.BlockList();
                                                blockList.addAddress('123.123.123.123');
                                                blockList.addRange('10.0.0.1', '10.0.0.10');
                                                blockList.addSubnet('8592:757c:efae:4e45::', 64, 'ipv6');

                                                console.log(blockList.check('123.123.123.123'));  // Prints: true
                                                console.log(blockList.check('10.0.0.3'));  // Prints: true
                                                console.log(blockList.check('222.111.111.222'));  // Prints: false

                                                // IPv6 notation for IPv4 addresses works:
                                                console.log(blockList.check('::ffff:7b7b:7b7b', 'ipv6')); // Prints: true
                                                console.log(blockList.check('::ffff:123.123.123.123', 'ipv6')); // Prints: true

                                                Parameters

                                                • address: string

                                                  The IP address to check

                                                  -
                                                • Optionaltype: IPVersion

                                                  Either 'ipv4' or 'ipv6'.

                                                  -

                                                Returns boolean

                                                v15.0.0, v14.18.0

                                                -

                                                • Returns true if the value is a net.BlockList.

                                                  +
                                                • Optionaltype: IPVersion

                                                  Either 'ipv4' or 'ipv6'.

                                                  +

                                                Returns boolean

                                                v15.0.0, v14.18.0

                                                +
                                                • Experimental
                                                  const blockList = new net.BlockList();
                                                  const data = [
                                                    'Subnet: IPv4 192.168.1.0/24',
                                                    'Address: IPv4 10.0.0.5',
                                                    'Range: IPv4 192.168.2.1-192.168.2.10',
                                                    'Range: IPv4 10.0.0.1-10.0.0.10',
                                                  ];
                                                  blockList.fromJSON(data);
                                                  blockList.fromJSON(JSON.stringify(data));
+
                                                  + +

                                                  Parameters

                                                  • data: string | readonly string[]

                                                  Returns void

                                                  v24.5.0

                                                  +
                                                • Experimental

                                                  Returns readonly string[]

                                                  v24.5.0

                                                  +

                                                • Returns true if the value is a net.BlockList.

                                                  Parameters

                                                  • value: unknown

                                                    Any JS value

                                                    -

                                                  Returns value is BlockList

                                                  v22.13.0

                                                  -

                                                Settings

                                                Member Visibility

                                                On This Page

                                                Constructors
                                                Properties
                                                Methods
                                                +

                                                Returns value is BlockList

                                                v22.13.0

                                                +

                                                Settings

                                                Member Visibility

                                                On This Page

                                                Constructors
                                                Properties
                                                Methods
                                                diff --git a/docs/classes/_internal_.ClientRequest.html b/docs/classes/_internal_.ClientRequest.html index 27f22646..7424be67 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 @@ -59,6 +59,7 @@ _final _write _writev? +[asyncDispose] [captureRejectionSymbol]? abort addListener @@ -108,32 +109,32 @@ once setMaxListeners toWeb -

                                                Constructors

                                                Properties

                                                aborted: boolean

                                                The request.aborted property will be true if the request has +

                                                Constructors

                                                Properties

                                                aborted: boolean

                                                The request.aborted property will be true if the request has been aborted.

                                                v0.11.14

                                                Since v17.0.0, v16.12.0 - Check destroyed instead.

                                                -
                                                chunkedEncoding: boolean
                                                closed: boolean

                                                Is true after 'close' has been emitted.

                                                +
                                                chunkedEncoding: boolean
                                                closed: boolean

                                                Is true after 'close' has been emitted.

                                                v18.0.0

                                                -
                                                connection: Socket

                                                Alias of outgoingMessage.socket.

                                                +
                                                connection: Socket

                                                Alias of outgoingMessage.socket.

                                                v0.3.0

                                                Since v15.12.0,v14.17.1 - Use socket instead.

                                                -
                                                destroyed: boolean

                                                Is true after writable.destroy() has been called.

                                                +
                                                destroyed: boolean

                                                Is true after writable.destroy() has been called.

                                                v8.0.0

                                                -
                                                errored: Error

                                                Returns error if the stream has been destroyed with an error.

                                                +
                                                errored: Error

                                                Returns error if the stream has been destroyed with an error.

                                                v18.0.0

                                                -
                                                finished: boolean

                                                Use writableEnded instead.

                                                -
                                                headersSent: boolean

                                                Read-only. true if the headers were sent, otherwise false.

                                                +
                                                finished: boolean

                                                Use writableEnded instead.

                                                +
                                                headersSent: boolean

                                                Read-only. true if the headers were sent, otherwise false.

                                                v0.9.3

                                                -
                                                host: string

                                                The request host.

                                                +
                                                host: string

                                                The request host.

                                                v14.5.0, v12.19.0

                                                -
                                                maxHeadersCount: number

                                                Limits maximum response headers count. If set to 0, no limit will be applied.

                                                -
                                                method: string

                                                The request method.

                                                +
                                                maxHeadersCount: number

                                                Limits maximum response headers count. If set to 0, no limit will be applied.

                                                +
                                                method: string

                                                The request method.

                                                v0.1.97

                                                -
                                                path: string

                                                The request path.

                                                +
                                                path: string

                                                The request path.

                                                v0.4.0

                                                -
                                                protocol: string

                                                The request protocol.

                                                +
                                                protocol: string

                                                The request protocol.

                                                v14.5.0, v12.19.0

                                                -
                                                req: IncomingMessage
                                                reusedSocket: boolean

                                                When sending request through a keep-alive enabled agent, the underlying socket +

                                                req: IncomingMessage
                                                reusedSocket: boolean

                                                When sending request through a keep-alive enabled agent, the underlying socket might be reused. But if server closes connection at unfortunate time, client may run into a 'ECONNRESET' error.

                                                import http from 'node:http';

                                                // Server has a 5 seconds keep-alive timeout by default
                                                http
                                                  .createServer((req, res) => {
                                                    res.write('hello\n');
                                                    res.end();
                                                  })
                                                  .listen(3000);

                                                setInterval(() => {
                                                  // Adapting a keep-alive agent
                                                  http.get('http://localhost:3000', { agent }, (res) => {
                                                    res.on('data', (data) => {
                                                      // Do nothing
                                                    });
                                                  });
                                                }, 5000); // Sending request on 5s interval so it's easy to hit idle timeout
@@ -145,40 +146,40 @@

                                                v13.0.0, v12.16.0

                                                -
                                                sendDate: boolean
                                                shouldKeepAlive: boolean
                                                socket: Socket

                                                Reference to the underlying socket. Usually, users will not want to access +

                                                sendDate: boolean
                                                shouldKeepAlive: boolean
                                                socket: Socket

                                                Reference to the underlying socket. Usually, users will not want to access this property.

                                                After calling outgoingMessage.end(), this property will be nulled.

                                                v0.3.0

                                                -
                                                useChunkedEncodingByDefault: boolean
                                                writable: boolean

                                                Is true if it is safe to call writable.write(), which means +

                                                useChunkedEncodingByDefault: boolean
                                                writable: boolean

                                                Is true if it is safe to call writable.write(), which means the stream has not been destroyed, errored, or ended.

                                                v11.4.0

                                                -
                                                writableAborted: boolean

                                                Returns whether the stream was destroyed or errored before emitting 'finish'.

                                                +
                                                writableAborted: boolean

                                                Returns whether the stream was destroyed or errored before emitting 'finish'.

                                                v18.0.0, v16.17.0

                                                -
                                                writableCorked: number

                                                Number of times writable.uncork() needs to be +

                                                writableCorked: number

                                                Number of times writable.uncork() needs to be called in order to fully uncork the stream.

                                                v13.2.0, v12.16.0

                                                -
                                                writableEnded: boolean

                                                Is true after writable.end() has been called. This property +

                                                writableEnded: boolean

                                                Is true after writable.end() has been called. This property does not indicate whether the data has been flushed, for this use writable.writableFinished instead.

                                                v12.9.0

                                                -
                                                writableFinished: boolean

                                                Is set to true immediately before the 'finish' event is emitted.

                                                +
                                                writableFinished: boolean

                                                Is set to true immediately before the 'finish' event is emitted.

                                                v12.6.0

                                                -
                                                writableHighWaterMark: number

                                                Return the value of highWaterMark passed when creating this Writable.

                                                +
                                                writableHighWaterMark: number

                                                Return the value of highWaterMark passed when creating this Writable.

                                                v9.3.0

                                                -
                                                writableLength: number

                                                This property contains the number of bytes (or objects) in the queue +

                                                writableLength: number

                                                This property contains the number of bytes (or objects) in the queue ready to be written. The value provides introspection data regarding the status of the highWaterMark.

                                                v9.4.0

                                                -
                                                writableNeedDrain: boolean

                                                Is true if the stream's buffer has been full and stream will emit 'drain'.

                                                +
                                                writableNeedDrain: boolean

                                                Is true if the stream's buffer has been full and stream will emit 'drain'.

                                                v15.2.0, v14.17.0

                                                -
                                                writableObjectMode: boolean

                                                Getter for the property objectMode of a given Writable stream.

                                                +
                                                writableObjectMode: boolean

                                                Getter for the property objectMode of a given Writable stream.

                                                v12.3.0

                                                -
                                                captureRejections: boolean

                                                Value: boolean

                                                +
                                                captureRejections: boolean

                                                Value: boolean

                                                Change the default captureRejections option on all new EventEmitter objects.

                                                v13.4.0, v12.16.0

                                                -
                                                captureRejectionSymbol: typeof captureRejectionSymbol

                                                Value: Symbol.for('nodejs.rejection')

                                                +
                                                captureRejectionSymbol: typeof captureRejectionSymbol

                                                Value: Symbol.for('nodejs.rejection')

                                                See how to write a custom rejection handler.

                                                v13.4.0, v12.16.0

                                                -
                                                defaultMaxListeners: number

                                                By default, a maximum of 10 listeners can be registered for any single +

                                                defaultMaxListeners: number

                                                By default, a maximum of 10 listeners can be registered for any single event. This limit can be changed for individual EventEmitter instances using the emitter.setMaxListeners(n) method. To change the default for allEventEmitter instances, the events.defaultMaxListeners property @@ -203,15 +204,18 @@ listeners, respectively. Its name property is set to 'MaxListenersExceededWarning'.

                                                v0.11.2

                                                -
                                                errorMonitor: typeof errorMonitor

                                                This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

                                                +
                                                errorMonitor: typeof errorMonitor

                                                This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

                                                Installing a listener using this symbol does not change the behavior once an 'error' event is emitted. Therefore, the process will still crash if no regular 'error' listener is installed.

                                                v13.6.0, v12.17.0

                                                -

                                                Methods

                                                Optional_construct

                                                • _construct(callback: (error?: Error) => void): void

                                                  Parameters

                                                  • callback: (error?: Error) => void

                                                  Returns void

                                                _destroy

                                                • _destroy(error: Error, callback: (error?: Error) => void): void

                                                  Parameters

                                                  • error: Error
                                                  • callback: (error?: Error) => void

                                                  Returns void

                                                _final

                                                • _final(callback: (error?: Error) => void): void

                                                  Parameters

                                                  • callback: (error?: Error) => void

                                                  Returns void

                                                _write

                                                • _write(
                                                      chunk: any,
                                                      encoding: BufferEncoding,
                                                      callback: (error?: Error) => void,
                                                  ): void

                                                  Parameters

                                                  Returns void

                                                Optional_writev

                                                • _writev(
                                                      chunks: { chunk: any; encoding: BufferEncoding }[],
                                                      callback: (error?: Error) => void,
                                                  ): void

                                                  Parameters

                                                  • chunks: { chunk: any; encoding: BufferEncoding }[]
                                                  • callback: (error?: Error) => void

                                                  Returns void

                                                • Type Parameters

                                                  • K

                                                  Parameters

                                                  • error: Error
                                                  • event: string | symbol
                                                  • ...args: AnyRest

                                                  Returns void

                                                • Marks the request as aborting. Calling this will cause remaining data +

                                                Methods

                                                Optional_construct

                                                • _construct?(callback: (error?: Error) => void): void

                                                  Parameters

                                                  • callback: (error?: Error) => void

                                                  Returns void

                                                _destroy

                                                • _destroy(error: Error, callback: (error?: Error) => void): void

                                                  Parameters

                                                  • error: Error
                                                  • callback: (error?: Error) => void

                                                  Returns void

                                                _final

                                                • _final(callback: (error?: Error) => void): void

                                                  Parameters

                                                  • callback: (error?: Error) => void

                                                  Returns void

                                                _write

                                                • _write(
                                                      chunk: any,
                                                      encoding: BufferEncoding,
                                                      callback: (error?: Error) => void,
                                                  ): void

                                                  Parameters

                                                  Returns void

                                                Optional_writev

                                                • _writev?(
                                                      chunks: { chunk: any; encoding: BufferEncoding }[],
                                                      callback: (error?: Error) => void,
                                                  ): void

                                                  Parameters

                                                  • chunks: { chunk: any; encoding: BufferEncoding }[]
                                                  • callback: (error?: Error) => void

                                                  Returns void

                                                • Calls writable.destroy() with an AbortError and returns +a promise that fulfills when the stream is finished.

                                                  +

                                                  Returns Promise<void>

                                                  v22.4.0, v20.16.0

                                                  +

                                                • Type Parameters

                                                  • K

                                                  Parameters

                                                  • error: Error
                                                  • event: string | symbol
                                                  • ...args: AnyRest

                                                  Returns void

                                                • Marks the request as aborting. Calling this will cause remaining data in the response to be dropped and the socket to be destroyed.

                                                  -

                                                  Returns void

                                                  v0.3.8

                                                  +

                                                  Returns void

                                                  v0.3.8

                                                  Since v14.1.0,v13.14.0 - Use destroy instead.

                                                  -

                                                • Parameters

                                                  • event: "abort"
                                                  • listener: () => void

                                                  Returns this

                                                • Parameters

                                                  Returns this

                                                • Parameters

                                                  • event: "continue"
                                                  • listener: () => void

                                                  Returns this

                                                • Parameters

                                                  Returns this

                                                • Parameters

                                                  Returns this

                                                • Parameters

                                                  • event: "socket"
                                                  • listener: (socket: Socket) => void

                                                  Returns this

                                                • Parameters

                                                  • event: "timeout"
                                                  • listener: () => void

                                                  Returns this

                                                • Parameters

                                                  Returns this

                                                • Parameters

                                                  • event: "close"
                                                  • listener: () => void

                                                  Returns this

                                                • Parameters

                                                  • event: "drain"
                                                  • listener: () => void

                                                  Returns this

                                                • Parameters

                                                  • event: "error"
                                                  • listener: (err: Error) => void

                                                  Returns this

                                                • Parameters

                                                  • event: "finish"
                                                  • listener: () => void

                                                  Returns this

                                                • Parameters

                                                  • event: "pipe"
                                                  • listener: (src: Readable) => void

                                                  Returns this

                                                • Parameters

                                                  • event: "unpipe"
                                                  • listener: (src: Readable) => void

                                                  Returns this

                                                • Parameters

                                                  • event: string | symbol
                                                  • listener: (...args: any[]) => void

                                                  Returns this

                                                • Adds HTTP trailers (headers but at the end of the message) to the message.

                                                  +

                                                • Parameters

                                                  • event: "abort"
                                                  • listener: () => void

                                                  Returns this

                                                • Parameters

                                                  Returns this

                                                • Parameters

                                                  • event: "continue"
                                                  • listener: () => void

                                                  Returns this

                                                • Parameters

                                                  Returns this

                                                • Parameters

                                                  Returns this

                                                • Parameters

                                                  • event: "socket"
                                                  • listener: (socket: Socket) => void

                                                  Returns this

                                                • Parameters

                                                  • event: "timeout"
                                                  • listener: () => void

                                                  Returns this

                                                • Parameters

                                                  Returns this

                                                • Parameters

                                                  • event: "close"
                                                  • listener: () => void

                                                  Returns this

                                                • Parameters

                                                  • event: "drain"
                                                  • listener: () => void

                                                  Returns this

                                                • Parameters

                                                  • event: "error"
                                                  • listener: (err: Error) => void

                                                  Returns this

                                                • Parameters

                                                  • event: "finish"
                                                  • listener: () => void

                                                  Returns this

                                                • Parameters

                                                  • event: "pipe"
                                                  • listener: (src: Readable) => void

                                                  Returns this

                                                • Parameters

                                                  • event: "unpipe"
                                                  • listener: (src: Readable) => void

                                                  Returns this

                                                • Parameters

                                                  • event: string | symbol
                                                  • listener: (...args: any[]) => void

                                                  Returns this

                                                • Adds HTTP trailers (headers but at the end of the message) to the message.

                                                  Trailers will only be emitted if the message is chunked encoded. If not, the trailers will be silently discarded.

                                                  HTTP requires the Trailer header to be sent to emit trailers, @@ -221,8 +225,8 @@

                                                  Attempting to set a header field name or value that contains invalid characters will result in a TypeError being thrown.

                                                  -

                                                  Parameters

                                                  Returns void

                                                  v0.3.0

                                                  -

                                                • Append a single header value to the header object.

                                                  +

                                                  Parameters

                                                  Returns void

                                                  v0.3.0

                                                  +

                                                • Append a single header value to the header object.

                                                  If the value is an array, this is equivalent to calling this method multiple times.

                                                  If there were no previous values for the header, this is equivalent to calling outgoingMessage.setHeader(name, value).

                                                  @@ -230,9 +234,9 @@ server were created, this will end up in the header being sent multiple times or a single time with values joined using ; .

                                                  Parameters

                                                  • name: string

                                                    Header name

                                                    -
                                                  • value: string | readonly string[]

                                                    Header value

                                                    -

                                                  Returns this

                                                  v18.3.0, v16.17.0

                                                  -

                                                • The writable.cork() method forces all written data to be buffered in memory. +

                                                • value: string | readonly string[]

                                                  Header value

                                                  +

                                                Returns this

                                                v18.3.0, v16.17.0

                                                +

                                                • The writable.cork() method forces all written data to be buffered in memory. The buffered data will be flushed when either the uncork or end methods are called.

                                                  The primary intent of writable.cork() is to accommodate a situation in which several small chunks are written to the stream in rapid succession. Instead of @@ -241,8 +245,8 @@ situation where data is being buffered while waiting for the first small chunk to be processed. However, use of writable.cork() without implementing writable._writev() may have an adverse effect on throughput.

                                                  See also: writable.uncork(), writable._writev().

                                                  -

                                                  Returns void

                                                  v0.11.2

                                                  -

                                                • Destroy the stream. Optionally emit an 'error' event, and emit a 'close' event (unless emitClose is set to false). After this call, the writable +

                                                  Returns void

                                                  v0.11.2

                                                  +

                                                • Destroy the stream. Optionally emit an 'error' event, and emit a 'close' event (unless emitClose is set to false). After this call, the writable stream has ended and subsequent calls to write() or end() will result in an ERR_STREAM_DESTROYED error. This is a destructive and immediate way to destroy a stream. Previous calls to write() may not have drained, and may trigger an ERR_STREAM_DESTROYED error. @@ -253,15 +257,15 @@

                                                  Implementors should not override this method, but instead implement writable._destroy().

                                                  Parameters

                                                  • Optionalerror: Error

                                                    Optional, an error to emit with 'error' event.

                                                    -

                                                  Returns this

                                                  v8.0.0

                                                  -

                                                • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments +

                                                Returns this

                                                v8.0.0

                                                +

                                                • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

                                                  Returns true if the event had listeners, false otherwise.

                                                  import { EventEmitter } from 'node:events';
                                                  const myEmitter = new EventEmitter();

                                                  // First listener
                                                  myEmitter.on('event', function firstListener() {
                                                    console.log('Helloooo! first listener');
                                                  });
                                                  // Second listener
                                                  myEmitter.on('event', function secondListener(arg1, arg2) {
                                                    console.log(`event with parameters ${arg1}, ${arg2} in second listener`);
                                                  });
                                                  // Third listener
                                                  myEmitter.on('event', function thirdListener(...args) {
                                                    const parameters = args.join(', ');
                                                    console.log(`event with parameters ${parameters} in third listener`);
                                                  });

                                                  console.log(myEmitter.listeners('event'));

                                                  myEmitter.emit('event', 1, 2, 3, 4, 5);

                                                  // Prints:
                                                  // [
                                                  //   [Function: firstListener],
                                                  //   [Function: secondListener],
                                                  //   [Function: thirdListener]
                                                  // ]
                                                  // Helloooo! first listener
                                                  // event with parameters 1, 2 in second listener
                                                  // event with parameters 1, 2, 3, 4, 5 in third listener
                                                  -

                                                  Parameters

                                                  • event: "close"

                                                  Returns boolean

                                                  v0.1.26

                                                  -

                                                • Parameters

                                                  • event: "drain"

                                                  Returns boolean

                                                • Parameters

                                                  • event: "error"
                                                  • err: Error

                                                  Returns boolean

                                                • Parameters

                                                  • event: "finish"

                                                  Returns boolean

                                                • Parameters

                                                  Returns boolean

                                                • Parameters

                                                  Returns boolean

                                                • Parameters

                                                  • event: string | symbol
                                                  • ...args: any[]

                                                  Returns boolean

                                                • Calling the writable.end() method signals that no more data will be written +

                                                  Parameters

                                                  • event: "close"

                                                  Returns boolean

                                                  v0.1.26

                                                  +

                                                • Parameters

                                                  • event: "drain"

                                                  Returns boolean

                                                • Parameters

                                                  • event: "error"
                                                  • err: Error

                                                  Returns boolean

                                                • Parameters

                                                  • event: "finish"

                                                  Returns boolean

                                                • Parameters

                                                  Returns boolean

                                                • Parameters

                                                  Returns boolean

                                                • Parameters

                                                  • event: string | symbol
                                                  • ...args: any[]

                                                  Returns boolean

                                                • Calling the writable.end() method signals that no more data will be written to the Writable. The optional chunk and encoding arguments allow one final additional chunk of data to be written immediately before closing the stream.

                                                  @@ -269,8 +273,8 @@ 
                                                  // Write 'hello, ' and then end with 'world!'.
                                                  import fs from 'node:fs';
                                                  const file = fs.createWriteStream('example.txt');
                                                  file.write('hello, ');
                                                  file.end('world!');
                                                  // Writing more now is not allowed!
                                                  -

                                                  Parameters

                                                  • Optionalcb: () => void

                                                  Returns this

                                                  v0.9.4

                                                  -

                                                • Calling the writable.end() method signals that no more data will be written +

                                                  Parameters

                                                  • Optionalcb: () => void

                                                  Returns this

                                                  v0.9.4

                                                  +

                                                • Calling the writable.end() method signals that no more data will be written to the Writable. The optional chunk and encoding arguments allow one final additional chunk of data to be written immediately before closing the stream.

                                                  @@ -280,8 +284,8 @@

                                                  Parameters

                                                  • chunk: any

                                                    Optional data to write. For streams not operating in object mode, chunk must be a {string}, {Buffer}, {TypedArray} or {DataView}. For object mode streams, chunk may be any JavaScript value other than null.

                                                    -
                                                  • Optionalcb: () => void

                                                  Returns this

                                                  v0.9.4

                                                  -

                                                • Calling the writable.end() method signals that no more data will be written +

                                                • Optionalcb: () => void

                                                Returns this

                                                v0.9.4

                                                +

                                              • Calling the writable.end() method signals that no more data will be written to the Writable. The optional chunk and encoding arguments allow one final additional chunk of data to be written immediately before closing the stream.

                                                @@ -291,30 +295,30 @@

                                                Parameters

                                                • chunk: any

                                                  Optional data to write. For streams not operating in object mode, chunk must be a {string}, {Buffer}, {TypedArray} or {DataView}. For object mode streams, chunk may be any JavaScript value other than null.

                                                  -
                                                • encoding: BufferEncoding

                                                  The encoding if chunk is a string

                                                  -
                                                • Optionalcb: () => void

                                                Returns this

                                                v0.9.4

                                                -

                                                • Returns an array listing the events for which the emitter has registered +

                                                • encoding: BufferEncoding

                                                  The encoding if chunk is a string

                                                  +
                                                • Optionalcb: () => void

                                                Returns this

                                                v0.9.4

                                                +

                                                • Returns an array listing the events for which the emitter has registered listeners. The values in the array are strings or Symbols.

                                                  import { EventEmitter } from 'node:events';

                                                  const myEE = new EventEmitter();
                                                  myEE.on('foo', () => {});
                                                  myEE.on('bar', () => {});

                                                  const sym = Symbol('symbol');
                                                  myEE.on(sym, () => {});

                                                  console.log(myEE.eventNames());
                                                  // Prints: [ 'foo', 'bar', Symbol(symbol) ]
                                                  -

                                                  Returns (string | symbol)[]

                                                  v6.0.0

                                                  -

                                                • Flushes the message headers.

                                                  +

                                                  Returns (string | symbol)[]

                                                  v6.0.0

                                                  +

                                                • Flushes the message headers.

                                                  For efficiency reason, Node.js normally buffers the message headers until outgoingMessage.end() is called or the first chunk of message data is written. It then tries to pack the headers and data into a single TCP packet.

                                                  It is usually desired (it saves a TCP round-trip), but not when the first data is not sent until possibly much later. outgoingMessage.flushHeaders() bypasses the optimization and kickstarts the message.

                                                  -

                                                  Returns void

                                                  v1.6.0

                                                  -

                                                • Gets the value of the HTTP header with the given name. If that header is not +

                                                  Returns void

                                                  v1.6.0

                                                  +

                                                • Gets the value of the HTTP header with the given name. If that header is not set, the returned value will be undefined.

                                                  Parameters

                                                  • name: string

                                                    Name of header

                                                    -

                                                  Returns string | number | string[]

                                                  v0.4.0

                                                  -

                                                • Returns an array containing the unique names of the current outgoing headers. +

                                                Returns string | number | string[]

                                                v0.4.0

                                                +

                                                • Returns an array containing the unique names of the current outgoing headers. All names are lowercase.

                                                  -

                                                  Returns string[]

                                                  v7.7.0

                                                  -

                                                • Returns a shallow copy of the current outgoing headers. Since a shallow copy is used, array values may be mutated without additional calls to various header-related HTTP module methods. The keys of the returned object are the header names and the values are the respective header @@ -326,54 +330,54 @@ 

                                                  outgoingMessage.setHeader('Foo', 'bar');
                                                  outgoingMessage.setHeader('Set-Cookie', ['foo=bar', 'bar=baz']);

                                                  const headers = outgoingMessage.getHeaders();
                                                  // headers === { foo: 'bar', 'set-cookie': ['foo=bar', 'bar=baz'] }
                                                  -

                                                  Returns OutgoingHttpHeaders

                                                  v7.7.0

                                                  -

                                                • Returns the current max listener value for the EventEmitter which is either +

                                                  Returns OutgoingHttpHeaders

                                                  v7.7.0

                                                  +

                                                • Returns the current max listener value for the EventEmitter which is either set by emitter.setMaxListeners(n) or defaults to EventEmitter.defaultMaxListeners.

                                                  -

                                                  Returns number

                                                  v1.0.0

                                                  -

                                                • Returns an array containing the unique names of the current outgoing raw +

                                                  Returns number

                                                  v1.0.0

                                                  +

                                                • Returns an array containing the unique names of the current outgoing raw headers. Header names are returned with their exact casing being set.

                                                  request.setHeader('Foo', 'bar');
                                                  request.setHeader('Set-Cookie', ['foo=bar', 'bar=baz']);

                                                  const headerNames = request.getRawHeaderNames();
                                                  // headerNames === ['Foo', 'Set-Cookie']
                                                  -

                                                  Returns string[]

                                                  v15.13.0, v14.17.0

                                                  -

                                                • Returns true if the header identified by name is currently set in the +

                                                  Returns string[]

                                                  v15.13.0, v14.17.0

                                                  +

                                                • Returns true if the header identified by name is currently set in the outgoing headers. The header name is case-insensitive.

                                                  const hasContentType = outgoingMessage.hasHeader('content-type');
                                                  -

                                                  Parameters

                                                  • name: string

                                                  Returns boolean

                                                  v7.7.0

                                                  -

                                                • Returns the number of listeners listening for the event named eventName. +

                                                  Parameters

                                                  • name: string

                                                  Returns boolean

                                                  v7.7.0

                                                  +

                                                • Returns the number of listeners listening for the event named eventName. If listener is provided, it will return how many times the listener is found in the list of the listeners of the event.

                                                  Type Parameters

                                                  • K

                                                  Parameters

                                                  • eventName: string | symbol

                                                    The name of the event being listened for

                                                    -
                                                  • Optionallistener: Function

                                                    The event handler function

                                                    -

                                                  Returns number

                                                  v3.2.0

                                                  -

                                                • Returns a copy of the array of listeners for the event named eventName.

                                                  +
                                                • Optionallistener: Function

                                                  The event handler function

                                                  +

                                                Returns number

                                                v3.2.0

                                                +

                                                • Returns a copy of the array of listeners for the event named eventName.

                                                  server.on('connection', (stream) => {
                                                    console.log('someone connected!');
                                                  });
                                                  console.log(util.inspect(server.listeners('connection')));
                                                  // Prints: [ [Function] ]
                                                  -

                                                  Type Parameters

                                                  • K

                                                  Parameters

                                                  • eventName: string | symbol

                                                  Returns Function[]

                                                  v0.1.26

                                                  -

                                                • Alias for emitter.removeListener().

                                                  -

                                                  Type Parameters

                                                  • K

                                                  Parameters

                                                  • eventName: string | symbol
                                                  • listener: (...args: any[]) => void

                                                  Returns this

                                                  v10.0.0

                                                  -

                                                • Parameters

                                                  • event: "abort"
                                                  • listener: () => void

                                                  Returns this

                                                • Parameters

                                                  Returns this

                                                • Parameters

                                                  • event: "continue"
                                                  • listener: () => void

                                                  Returns this

                                                • Parameters

                                                  Returns this

                                                • Parameters

                                                  Returns this

                                                • Parameters

                                                  • event: "socket"
                                                  • listener: (socket: Socket) => void

                                                  Returns this

                                                • Parameters

                                                  • event: "timeout"
                                                  • listener: () => void

                                                  Returns this

                                                • Parameters

                                                  Returns this

                                                • Parameters

                                                  • event: "close"
                                                  • listener: () => void

                                                  Returns this

                                                • Parameters

                                                  • event: "drain"
                                                  • listener: () => void

                                                  Returns this

                                                • Parameters

                                                  • event: "error"
                                                  • listener: (err: Error) => void

                                                  Returns this

                                                • Parameters

                                                  • event: "finish"
                                                  • listener: () => void

                                                  Returns this

                                                • Parameters

                                                  • event: "pipe"
                                                  • listener: (src: Readable) => void

                                                  Returns this

                                                • Parameters

                                                  • event: "unpipe"
                                                  • listener: (src: Readable) => void

                                                  Returns this

                                                • Parameters

                                                  • event: string | symbol
                                                  • listener: (...args: any[]) => void

                                                  Returns this

                                                • Parameters

                                                  • event: "abort"
                                                  • listener: () => void

                                                  Returns this

                                                • Parameters

                                                  Returns this

                                                • Parameters

                                                  • event: "continue"
                                                  • listener: () => void

                                                  Returns this

                                                • Parameters

                                                  Returns this

                                                • Parameters

                                                  Returns this

                                                • Parameters

                                                  • event: "socket"
                                                  • listener: (socket: Socket) => void

                                                  Returns this

                                                • Parameters

                                                  • event: "timeout"
                                                  • listener: () => void

                                                  Returns this

                                                • Parameters

                                                  Returns this

                                                • Parameters

                                                  • event: "close"
                                                  • listener: () => void

                                                  Returns this

                                                • Parameters

                                                  • event: "drain"
                                                  • listener: () => void

                                                  Returns this

                                                • Parameters

                                                  • event: "error"
                                                  • listener: (err: Error) => void

                                                  Returns this

                                                • Parameters

                                                  • event: "finish"
                                                  • listener: () => void

                                                  Returns this

                                                • Parameters

                                                  • event: "pipe"
                                                  • listener: (src: Readable) => void

                                                  Returns this

                                                • Parameters

                                                  • event: "unpipe"
                                                  • listener: (src: Readable) => void

                                                  Returns this

                                                • Parameters

                                                  • event: string | symbol
                                                  • listener: (...args: any[]) => void

                                                  Returns this

                                                • Parameters

                                                  Returns void

                                                • Type Parameters

                                                  Parameters

                                                  • destination: T
                                                  • Optionaloptions: { end?: boolean }

                                                  Returns T

                                                • Parameters

                                                  • event: "abort"
                                                  • listener: () => void

                                                  Returns this

                                                • Parameters

                                                  Returns this

                                                • Parameters

                                                  • event: "continue"
                                                  • listener: () => void

                                                  Returns this

                                                • Parameters

                                                  Returns this

                                                • Parameters

                                                  Returns this

                                                • Parameters

                                                  • event: "socket"
                                                  • listener: (socket: Socket) => void

                                                  Returns this

                                                • Parameters

                                                  • event: "timeout"
                                                  • listener: () => void

                                                  Returns this

                                                • Parameters

                                                  Returns this

                                                • Parameters

                                                  • event: "close"
                                                  • listener: () => void

                                                  Returns this

                                                • Parameters

                                                  • event: "drain"
                                                  • listener: () => void

                                                  Returns this

                                                • Parameters

                                                  • event: "error"
                                                  • listener: (err: Error) => void

                                                  Returns this

                                                • Parameters

                                                  • event: "finish"
                                                  • listener: () => void

                                                  Returns this

                                                • Parameters

                                                  • event: "pipe"
                                                  • listener: (src: Readable) => void

                                                  Returns this

                                                • Parameters

                                                  • event: "unpipe"
                                                  • listener: (src: Readable) => void

                                                  Returns this

                                                • Parameters

                                                  • event: string | symbol
                                                  • listener: (...args: any[]) => void

                                                  Returns this

                                                • Parameters

                                                  • event: "abort"
                                                  • listener: () => void

                                                  Returns this

                                                • Parameters

                                                  Returns this

                                                • Parameters

                                                  • event: "continue"
                                                  • listener: () => void

                                                  Returns this

                                                • Parameters

                                                  Returns this

                                                • Parameters

                                                  Returns this

                                                • Parameters

                                                  • event: "socket"
                                                  • listener: (socket: Socket) => void

                                                  Returns this

                                                • Parameters

                                                  • event: "timeout"
                                                  • listener: () => void

                                                  Returns this

                                                • Parameters

                                                  Returns this

                                                • Parameters

                                                  • event: "close"
                                                  • listener: () => void

                                                  Returns this

                                                • Parameters

                                                  • event: "drain"
                                                  • listener: () => void

                                                  Returns this

                                                • Parameters

                                                  • event: "error"
                                                  • listener: (err: Error) => void

                                                  Returns this

                                                • Parameters

                                                  • event: "finish"
                                                  • listener: () => void

                                                  Returns this

                                                • Parameters

                                                  • event: "pipe"
                                                  • listener: (src: Readable) => void

                                                  Returns this

                                                • Parameters

                                                  • event: "unpipe"
                                                  • listener: (src: Readable) => void

                                                  Returns this

                                                • Parameters

                                                  • event: string | symbol
                                                  • listener: (...args: any[]) => void

                                                  Returns this

                                                • Returns a copy of the array of listeners for the event named eventName, +

                                                  Type Parameters

                                                  • K

                                                  Parameters

                                                  • eventName: string | symbol

                                                  Returns Function[]

                                                  v0.1.26

                                                  +

                                                • Alias for emitter.removeListener().

                                                  +

                                                  Type Parameters

                                                  • K

                                                  Parameters

                                                  • eventName: string | symbol
                                                  • listener: (...args: any[]) => void

                                                  Returns this

                                                  v10.0.0

                                                  +

                                                • Parameters

                                                  • event: "abort"
                                                  • listener: () => void

                                                  Returns this

                                                • Parameters

                                                  Returns this

                                                • Parameters

                                                  • event: "continue"
                                                  • listener: () => void

                                                  Returns this

                                                • Parameters

                                                  Returns this

                                                • Parameters

                                                  Returns this

                                                • Parameters

                                                  • event: "socket"
                                                  • listener: (socket: Socket) => void

                                                  Returns this

                                                • Parameters

                                                  • event: "timeout"
                                                  • listener: () => void

                                                  Returns this

                                                • Parameters

                                                  Returns this

                                                • Parameters

                                                  • event: "close"
                                                  • listener: () => void

                                                  Returns this

                                                • Parameters

                                                  • event: "drain"
                                                  • listener: () => void

                                                  Returns this

                                                • Parameters

                                                  • event: "error"
                                                  • listener: (err: Error) => void

                                                  Returns this

                                                • Parameters

                                                  • event: "finish"
                                                  • listener: () => void

                                                  Returns this

                                                • Parameters

                                                  • event: "pipe"
                                                  • listener: (src: Readable) => void

                                                  Returns this

                                                • Parameters

                                                  • event: "unpipe"
                                                  • listener: (src: Readable) => void

                                                  Returns this

                                                • Parameters

                                                  • event: string | symbol
                                                  • listener: (...args: any[]) => void

                                                  Returns this

                                                • Parameters

                                                  • event: "abort"
                                                  • listener: () => void

                                                  Returns this

                                                • Parameters

                                                  Returns this

                                                • Parameters

                                                  • event: "continue"
                                                  • listener: () => void

                                                  Returns this

                                                • Parameters

                                                  Returns this

                                                • Parameters

                                                  Returns this

                                                • Parameters

                                                  • event: "socket"
                                                  • listener: (socket: Socket) => void

                                                  Returns this

                                                • Parameters

                                                  • event: "timeout"
                                                  • listener: () => void

                                                  Returns this

                                                • Parameters

                                                  Returns this

                                                • Parameters

                                                  • event: "close"
                                                  • listener: () => void

                                                  Returns this

                                                • Parameters

                                                  • event: "drain"
                                                  • listener: () => void

                                                  Returns this

                                                • Parameters

                                                  • event: "error"
                                                  • listener: (err: Error) => void

                                                  Returns this

                                                • Parameters

                                                  • event: "finish"
                                                  • listener: () => void

                                                  Returns this

                                                • Parameters

                                                  • event: "pipe"
                                                  • listener: (src: Readable) => void

                                                  Returns this

                                                • Parameters

                                                  • event: "unpipe"
                                                  • listener: (src: Readable) => void

                                                  Returns this

                                                • Parameters

                                                  • event: string | symbol
                                                  • listener: (...args: any[]) => void

                                                  Returns this

                                                • Parameters

                                                  Returns void

                                                • Type Parameters

                                                  Parameters

                                                  • destination: T
                                                  • Optionaloptions: { end?: boolean }

                                                  Returns T

                                                • Parameters

                                                  • event: "abort"
                                                  • listener: () => void

                                                  Returns this

                                                • Parameters

                                                  Returns this

                                                • Parameters

                                                  • event: "continue"
                                                  • listener: () => void

                                                  Returns this

                                                • Parameters

                                                  Returns this

                                                • Parameters

                                                  Returns this

                                                • Parameters

                                                  • event: "socket"
                                                  • listener: (socket: Socket) => void

                                                  Returns this

                                                • Parameters

                                                  • event: "timeout"
                                                  • listener: () => void

                                                  Returns this

                                                • Parameters

                                                  Returns this

                                                • Parameters

                                                  • event: "close"
                                                  • listener: () => void

                                                  Returns this

                                                • Parameters

                                                  • event: "drain"
                                                  • listener: () => void

                                                  Returns this

                                                • Parameters

                                                  • event: "error"
                                                  • listener: (err: Error) => void

                                                  Returns this

                                                • Parameters

                                                  • event: "finish"
                                                  • listener: () => void

                                                  Returns this

                                                • Parameters

                                                  • event: "pipe"
                                                  • listener: (src: Readable) => void

                                                  Returns this

                                                • Parameters

                                                  • event: "unpipe"
                                                  • listener: (src: Readable) => void

                                                  Returns this

                                                • Parameters

                                                  • event: string | symbol
                                                  • listener: (...args: any[]) => void

                                                  Returns this

                                                • Parameters

                                                  • event: "abort"
                                                  • listener: () => void

                                                  Returns this

                                                • Parameters

                                                  Returns this

                                                • Parameters

                                                  • event: "continue"
                                                  • listener: () => void

                                                  Returns this

                                                • Parameters

                                                  Returns this

                                                • Parameters

                                                  Returns this

                                                • Parameters

                                                  • event: "socket"
                                                  • listener: (socket: Socket) => void

                                                  Returns this

                                                • Parameters

                                                  • event: "timeout"
                                                  • listener: () => void

                                                  Returns this

                                                • Parameters

                                                  Returns this

                                                • Parameters

                                                  • event: "close"
                                                  • listener: () => void

                                                  Returns this

                                                • Parameters

                                                  • event: "drain"
                                                  • listener: () => void

                                                  Returns this

                                                • Parameters

                                                  • event: "error"
                                                  • listener: (err: Error) => void

                                                  Returns this

                                                • Parameters

                                                  • event: "finish"
                                                  • listener: () => void

                                                  Returns this

                                                • Parameters

                                                  • event: "pipe"
                                                  • listener: (src: Readable) => void

                                                  Returns this

                                                • Parameters

                                                  • event: "unpipe"
                                                  • listener: (src: Readable) => void

                                                  Returns this

                                                • Parameters

                                                  • event: string | symbol
                                                  • listener: (...args: any[]) => void

                                                  Returns this

                                                • Returns a copy of the array of listeners for the event named eventName, including any wrappers (such as those created by .once()).

                                                  import { EventEmitter } from 'node:events';
                                                  const emitter = new EventEmitter();
                                                  emitter.once('log', () => console.log('log once'));

                                                  // Returns a new Array with a function `onceWrapper` which has a property
                                                  // `listener` which contains the original listener bound above
                                                  const listeners = emitter.rawListeners('log');
                                                  const logFnWrapper = listeners[0];

                                                  // Logs "log once" to the console and does not unbind the `once` event
                                                  logFnWrapper.listener();

                                                  // Logs "log once" to the console and removes the listener
                                                  logFnWrapper();

                                                  emitter.on('log', () => console.log('log persistently'));
                                                  // Will return a new Array with a single function bound by `.on()` above
                                                  const newListeners = emitter.rawListeners('log');

                                                  // Logs "log persistently" twice
                                                  newListeners[0]();
                                                  emitter.emit('log');
                                                  -

                                                  Type Parameters

                                                  • K

                                                  Parameters

                                                  • eventName: string | symbol

                                                  Returns Function[]

                                                  v9.4.0

                                                  -

                                                • Removes all listeners, or those of the specified eventName.

                                                  +

                                                  Type Parameters

                                                  • K

                                                  Parameters

                                                  • eventName: string | symbol

                                                  Returns Function[]

                                                  v9.4.0

                                                  +

                                                • Removes all listeners, or those of the specified eventName.

                                                  It is bad practice to remove listeners added elsewhere in the code, particularly when the EventEmitter instance was created by some other component or module (e.g. sockets or file streams).

                                                  Returns a reference to the EventEmitter, so that calls can be chained.

                                                  -

                                                  Parameters

                                                  • OptionaleventName: string | symbol

                                                  Returns this

                                                  v0.1.26

                                                  -

                                                • Removes a header that is queued for implicit sending.

                                                  +

                                                  Parameters

                                                  • OptionaleventName: string | symbol

                                                  Returns this

                                                  v0.1.26

                                                  +

                                                • Removes a header that is queued for implicit sending.

                                                  outgoingMessage.removeHeader('Content-Encoding');

                                                  Parameters

                                                  • name: string

                                                    Header name

                                                    -

                                                  Returns void

                                                  v0.4.0

                                                  -

                                                • Removes the specified listener from the listener array for the event named eventName.

                                                  +

                                                Returns void

                                                v0.4.0

                                                +

                                                • Removes the specified listener from the listener array for the event named eventName.

                                                  const callback = (stream) => {
                                                    console.log('someone connected!');
                                                  };
                                                  server.on('connection', callback);
                                                  // ...
                                                  server.removeListener('connection', callback);
                                                  @@ -399,17 +403,17 @@

                                                  Returns a reference to the EventEmitter, so that calls can be chained.

                                                  -

                                                  Parameters

                                                  • event: "close"
                                                  • listener: () => void

                                                  Returns this

                                                  v0.1.26

                                                  -

                                                • Parameters

                                                  • event: "drain"
                                                  • listener: () => void

                                                  Returns this

                                                • Parameters

                                                  • event: "error"
                                                  • listener: (err: Error) => void

                                                  Returns this

                                                • Parameters

                                                  • event: "finish"
                                                  • listener: () => void

                                                  Returns this

                                                • Parameters

                                                  • event: "pipe"
                                                  • listener: (src: Readable) => void

                                                  Returns this

                                                • Parameters

                                                  • event: "unpipe"
                                                  • listener: (src: Readable) => void

                                                  Returns this

                                                • Parameters

                                                  • event: string | symbol
                                                  • listener: (...args: any[]) => void

                                                  Returns this

                                                • The writable.setDefaultEncoding() method sets the default encoding for a Writable stream.

                                                  +

                                                  Parameters

                                                  • event: "close"
                                                  • listener: () => void

                                                  Returns this

                                                  v0.1.26

                                                  +

                                                • Parameters

                                                  • event: "drain"
                                                  • listener: () => void

                                                  Returns this

                                                • Parameters

                                                  • event: "error"
                                                  • listener: (err: Error) => void

                                                  Returns this

                                                • Parameters

                                                  • event: "finish"
                                                  • listener: () => void

                                                  Returns this

                                                • Parameters

                                                  • event: "pipe"
                                                  • listener: (src: Readable) => void

                                                  Returns this

                                                • Parameters

                                                  • event: "unpipe"
                                                  • listener: (src: Readable) => void

                                                  Returns this

                                                • Parameters

                                                  • event: string | symbol
                                                  • listener: (...args: any[]) => void

                                                  Returns this

                                                • The writable.setDefaultEncoding() method sets the default encoding for a Writable stream.

                                                  Parameters

                                                  Returns this

                                                  v0.11.15

                                                  -

                                                • Sets a single header value. If the header already exists in the to-be-sent +

                                                Returns this

                                                v0.11.15

                                                +

                                                • Sets a single header value. If the header already exists in the to-be-sent headers, its value will be replaced. Use an array of strings to send multiple headers with the same name.

                                                  Parameters

                                                  • name: string

                                                    Header name

                                                    -
                                                  • value: string | number | readonly string[]

                                                    Header value

                                                    -

                                                  Returns this

                                                  v0.4.0

                                                  -

                                                • Sets multiple header values for implicit headers. headers must be an instance of +

                                                • value: string | number | readonly string[]

                                                  Header value

                                                  +

                                                Returns this

                                                v0.4.0

                                                +

                                                • Sets multiple header values for implicit headers. headers must be an instance of Headers or Map, if a header already exists in the to-be-sent headers, its value will be replaced.

                                                  const headers = new Headers({ foo: 'bar' });
                                                  outgoingMessage.setHeaders(headers);
@@ -425,22 +429,22 @@
 
                                                  // Returns content-type = text/plain
                                                  const server = http.createServer((req, res) => {
                                                    const headers = new Headers({ 'Content-Type': 'text/html' });
                                                    res.setHeaders(headers);
                                                    res.writeHead(200, { 'Content-Type': 'text/plain' });
                                                    res.end('ok');
                                                  });
 
                                                  
 
-

                                                  Parameters

                                                  • headers: Headers | Map<string, string | number | readonly string[]>

                                                  Returns this

                                                  v19.6.0, v18.15.0

                                                  -

                                                • By default EventEmitters will print a warning if more than 10 listeners are +

                                                  Parameters

                                                  • headers: Headers | Map<string, string | number | readonly string[]>

                                                  Returns this

                                                  v19.6.0, v18.15.0

                                                  +

                                                • By default EventEmitters will print a warning if more than 10 listeners are added for a particular event. This is a useful default that helps finding memory leaks. The emitter.setMaxListeners() method allows the limit to be modified for this specific EventEmitter instance. The value can be set to Infinity (or 0) to indicate an unlimited number of listeners.

                                                  Returns a reference to the EventEmitter, so that calls can be chained.

                                                  -

                                                  Parameters

                                                  • n: number

                                                  Returns this

                                                  v0.3.5

                                                  -

                                                • Once a socket is assigned to this request and is connected socket.setNoDelay() will be called.

                                                  -

                                                  Parameters

                                                  • OptionalnoDelay: boolean

                                                  Returns void

                                                  v0.5.9

                                                  -

                                                • Once a socket is assigned to this request and is connected socket.setKeepAlive() will be called.

                                                  -

                                                  Parameters

                                                  • Optionalenable: boolean
                                                  • OptionalinitialDelay: number

                                                  Returns void

                                                  v0.5.9

                                                  -

                                                • Once a socket is assigned to this request and is connected socket.setTimeout() will be called.

                                                  +

                                                  Parameters

                                                  • n: number

                                                  Returns this

                                                  v0.3.5

                                                  +

                                                • Once a socket is assigned to this request and is connected socket.setNoDelay() will be called.

                                                  +

                                                  Parameters

                                                  • OptionalnoDelay: boolean

                                                  Returns void

                                                  v0.5.9

                                                  +

                                                • Once a socket is assigned to this request and is connected socket.setKeepAlive() will be called.

                                                  +

                                                  Parameters

                                                  • Optionalenable: boolean
                                                  • OptionalinitialDelay: number

                                                  Returns void

                                                  v0.5.9

                                                  +

                                                • Once a socket is assigned to this request and is connected socket.setTimeout() will be called.

                                                  Parameters

                                                  • timeout: number

                                                    Milliseconds before a request times out.

                                                    -
                                                  • Optionalcallback: () => void

                                                    Optional function to be called when a timeout occurs. Same as binding to the 'timeout' event.

                                                    -

                                                  Returns this

                                                  v0.5.9

                                                  -

                                                • The writable.uncork() method flushes all data buffered since cork was called.

                                                  +
                                                • Optionalcallback: () => void

                                                  Optional function to be called when a timeout occurs. Same as binding to the 'timeout' event.

                                                  +

                                                Returns this

                                                v0.5.9

                                                +

                                                • The writable.uncork() method flushes all data buffered since cork was called.

                                                  When using writable.cork() and writable.uncork() to manage the buffering of writes to a stream, defer calls to writable.uncork() using process.nextTick(). Doing so allows batching of all writable.write() calls that occur within a given Node.js event loop phase.

                                                  @@ -454,8 +458,8 @@

                                                  See also: writable.cork().

                                                  -

                                                  Returns void

                                                  v0.11.2

                                                  -

                                                • The writable.write() method writes some data to the stream, and calls the +

                                                  Returns void

                                                  v0.11.2

                                                  +

                                                • The writable.write() method writes some data to the stream, and calls the supplied callback once the data has been fully handled. If an error occurs, the callback will be called with the error as its first argument. The callback is called asynchronously and before 'error' is @@ -488,10 +492,10 @@

                                                  A Writable stream in object mode will always ignore the encoding argument.

                                                  Parameters

                                                  • chunk: any

                                                    Optional data to write. For streams not operating in object mode, chunk must be a {string}, {Buffer}, {TypedArray} or {DataView}. For object mode streams, chunk may be any JavaScript value other than null.

                                                    -
                                                  • Optionalcallback: (error: Error) => void

                                                    Callback for when this chunk of data is flushed.

                                                    -

                                                  Returns boolean

                                                  false if the stream wishes for the calling code to wait for the 'drain' event to be emitted before continuing to write additional data; otherwise true.

                                                  -

                                                  v0.9.4

                                                  -

                                                • The writable.write() method writes some data to the stream, and calls the +

                                                • Optionalcallback: (error: Error) => void

                                                  Callback for when this chunk of data is flushed.

                                                  +

                                                Returns boolean

                                                false if the stream wishes for the calling code to wait for the 'drain' event to be emitted before continuing to write additional data; otherwise true.

                                                +

                                                v0.9.4

                                                +

                                              • The writable.write() method writes some data to the stream, and calls the supplied callback once the data has been fully handled. If an error occurs, the callback will be called with the error as its first argument. The callback is called asynchronously and before 'error' is @@ -524,11 +528,11 @@

                                                A Writable stream in object mode will always ignore the encoding argument.

                                                Parameters

                                                • chunk: any

                                                  Optional data to write. For streams not operating in object mode, chunk must be a {string}, {Buffer}, {TypedArray} or {DataView}. For object mode streams, chunk may be any JavaScript value other than null.

                                                  -
                                                • encoding: BufferEncoding

                                                  The encoding, if chunk is a string.

                                                  -
                                                • Optionalcallback: (error: Error) => void

                                                  Callback for when this chunk of data is flushed.

                                                  -

                                                Returns boolean

                                                false if the stream wishes for the calling code to wait for the 'drain' event to be emitted before continuing to write additional data; otherwise true.

                                                -

                                                v0.9.4

                                                -

                                                • Listens once to the abort event on the provided signal.

                                                  +
                                                • encoding: BufferEncoding

                                                  The encoding, if chunk is a string.

                                                  +
                                                • Optionalcallback: (error: Error) => void

                                                  Callback for when this chunk of data is flushed.

                                                  +

                                                Returns boolean

                                                false if the stream wishes for the calling code to wait for the 'drain' event to be emitted before continuing to write additional data; otherwise true.

                                                +

                                                v0.9.4

                                                +

                                                • Listens once to the abort event on the provided signal.

                                                  Listening to the abort event on abort signals is unsafe and may lead to resource leaks since another third party with the signal can call e.stopImmediatePropagation(). Unfortunately Node.js cannot change @@ -542,10 +546,10 @@

                                                  Parameters

                                                  Returns Disposable

                                                  Disposable that removes the abort listener.

                                                  -

                                                  v20.5.0

                                                  -

                                                • A utility method for creating a Writable from a web WritableStream.

                                                  -

                                                  Parameters

                                                  • writableStream: WritableStream
                                                  • Optionaloptions: Pick<
                                                        WritableOptions,
                                                        "decodeStrings"
                                                        | "highWaterMark"
                                                        | "objectMode"
                                                        | "signal",
                                                    >

                                                  Returns Writable

                                                  v17.0.0

                                                  -

                                                • A utility method for creating a Writable from a web WritableStream.

                                                  +

                                                  Parameters

                                                  • writableStream: WritableStream
                                                  • Optionaloptions: Pick<
                                                        WritableOptions,
                                                        "decodeStrings"
                                                        | "highWaterMark"
                                                        | "objectMode"
                                                        | "signal",
                                                    >

                                                  Returns Writable

                                                  v17.0.0

                                                  +

                                                • Returns a copy of the array of listeners for the event named eventName.

                                                  For EventEmitters this behaves exactly the same as calling .listeners on the emitter.

                                                  For EventTargets this is the only way to get the event listeners for the @@ -553,8 +557,8 @@ 

                                                  import { getEventListeners, EventEmitter } from 'node:events';

                                                  {
                                                    const ee = new EventEmitter();
                                                    const listener = () => console.log('Events are fun');
                                                    ee.on('foo', listener);
                                                    console.log(getEventListeners(ee, 'foo')); // [ [Function: listener] ]
                                                  }
                                                  {
                                                    const et = new EventTarget();
                                                    const listener = () => console.log('Events are fun');
                                                    et.addEventListener('foo', listener);
                                                    console.log(getEventListeners(et, 'foo')); // [ [Function: listener] ]
                                                  }
                                                  -

                                                  Parameters

                                                  Returns Function[]

                                                  v15.2.0, v14.17.0

                                                  -

                                                • Returns the currently set max amount of listeners.

                                                  For EventEmitters this behaves exactly the same as calling .getMaxListeners on the emitter.

                                                  For EventTargets this is the only way to get the max event listeners for the @@ -563,16 +567,16 @@ 

                                                  import { getMaxListeners, setMaxListeners, EventEmitter } from 'node:events';

                                                  {
                                                    const ee = new EventEmitter();
                                                    console.log(getMaxListeners(ee)); // 10
                                                    setMaxListeners(11, ee);
                                                    console.log(getMaxListeners(ee)); // 11
                                                  }
                                                  {
                                                    const et = new EventTarget();
                                                    console.log(getMaxListeners(et)); // 10
                                                    setMaxListeners(11, et);
                                                    console.log(getMaxListeners(et)); // 11
                                                  }
                                                  -

                                                  Parameters

                                                  Returns number

                                                  v19.9.0

                                                  -

                                                • A class method that returns the number of listeners for the given eventName registered on the given emitter.

                                                  import { EventEmitter, listenerCount } from 'node:events';

                                                  const myEmitter = new EventEmitter();
                                                  myEmitter.on('event', () => {});
                                                  myEmitter.on('event', () => {});
                                                  console.log(listenerCount(myEmitter, 'event'));
                                                  // Prints: 2

                                                  Parameters

                                                  • emitter: EventEmitter

                                                    The emitter to query

                                                    -
                                                  • eventName: string | symbol

                                                    The event name

                                                    -

                                                  Returns number

                                                  v0.9.12

                                                  +
                                                • eventName: string | symbol

                                                  The event name

                                                  +

                                                Returns number

                                                v0.9.12

                                                Since v3.2.0 - Use listenerCount instead.

                                                -
                                                • import { on, EventEmitter } from 'node:events';
                                                  import process from 'node:process';

                                                  const ee = new EventEmitter();

                                                  // Emit later on
                                                  process.nextTick(() => {
                                                    ee.emit('foo', 'bar');
                                                    ee.emit('foo', 42);
                                                  });

                                                  for await (const event of on(ee, 'foo')) {
                                                    // The execution of this inner block is synchronous and it
                                                    // processes one event at a time (even with await). Do not use
                                                    // if concurrent execution is required.
                                                    console.log(event); // prints ['bar'] [42]
                                                  }
                                                  // Unreachable here
+
                                                • import { on, EventEmitter } from 'node:events';
                                                  import process from 'node:process';

                                                  const ee = new EventEmitter();

                                                  // Emit later on
                                                  process.nextTick(() => {
                                                    ee.emit('foo', 'bar');
                                                    ee.emit('foo', 42);
                                                  });

                                                  for await (const event of on(ee, 'foo')) {
                                                    // The execution of this inner block is synchronous and it
                                                    // processes one event at a time (even with await). Do not use
                                                    // if concurrent execution is required.
                                                    console.log(event); // prints ['bar'] [42]
                                                  }
                                                  // Unreachable here

                                                  Returns an AsyncIterator that iterates eventName events. It will throw @@ -588,8 +592,8 @@

                                                  Parameters

                                                  Returns AsyncIterator<any[]>

                                                  An AsyncIterator that iterates eventName events emitted by the emitter

                                                  -

                                                  v13.6.0, v12.16.0

                                                  -
                                                • import { on, EventEmitter } from 'node:events';
                                                  import process from 'node:process';

                                                  const ee = new EventEmitter();

                                                  // Emit later on
                                                  process.nextTick(() => {
                                                    ee.emit('foo', 'bar');
                                                    ee.emit('foo', 42);
                                                  });

                                                  for await (const event of on(ee, 'foo')) {
                                                    // The execution of this inner block is synchronous and it
                                                    // processes one event at a time (even with await). Do not use
                                                    // if concurrent execution is required.
                                                    console.log(event); // prints ['bar'] [42]
                                                  }
                                                  // Unreachable here
+
                                                  v13.6.0, v12.16.0
                                                  
+
                                                • import { on, EventEmitter } from 'node:events';
                                                  import process from 'node:process';

                                                  const ee = new EventEmitter();

                                                  // Emit later on
                                                  process.nextTick(() => {
                                                    ee.emit('foo', 'bar');
                                                    ee.emit('foo', 42);
                                                  });

                                                  for await (const event of on(ee, 'foo')) {
                                                    // The execution of this inner block is synchronous and it
                                                    // processes one event at a time (even with await). Do not use
                                                    // if concurrent execution is required.
                                                    console.log(event); // prints ['bar'] [42]
                                                  }
                                                  // Unreachable here

                                                  Returns an AsyncIterator that iterates eventName events. It will throw @@ -605,8 +609,8 @@

                                                  Parameters

                                                  Returns AsyncIterator<any[]>

                                                  An AsyncIterator that iterates eventName events emitted by the emitter

                                                  -

                                                  v13.6.0, v12.16.0

                                                  -

                                                • Creates a Promise that is fulfilled when the EventEmitter emits the given +

                                                  v13.6.0, v12.16.0

                                                  +

                                                • Creates a Promise that is fulfilled when the EventEmitter emits the given event or that is rejected if the EventEmitter emits 'error' while waiting. The Promise will resolve with an array of all the arguments emitted to the given event.

                                                  @@ -625,8 +629,8 @@ 
                                                  import { EventEmitter, once } from 'node:events';

                                                  const ee = new EventEmitter();
                                                  const ac = new AbortController();

                                                  async function foo(emitter, event, signal) {
                                                    try {
                                                      await once(emitter, event, { signal });
                                                      console.log('event emitted!');
                                                    } catch (error) {
                                                      if (error.name === 'AbortError') {
                                                        console.error('Waiting for the event was canceled!');
                                                      } else {
                                                        console.error('There was an error', error.message);
                                                      }
                                                    }
                                                  }

                                                  foo(ee, 'foo', ac.signal);
                                                  ac.abort(); // Abort waiting for the event
                                                  ee.emit('foo'); // Prints: Waiting for the event was canceled!
                                                  -

                                                  Parameters

                                                  Returns Promise<any[]>

                                                  v11.13.0, v10.16.0

                                                  -

                                                • Creates a Promise that is fulfilled when the EventEmitter emits the given +

                                                  Parameters

                                                  Returns Promise<any[]>

                                                  v11.13.0, v10.16.0

                                                  +

                                                • Creates a Promise that is fulfilled when the EventEmitter emits the given event or that is rejected if the EventEmitter emits 'error' while waiting. The Promise will resolve with an array of all the arguments emitted to the given event.

                                                  @@ -645,14 +649,14 @@ 
                                                  import { EventEmitter, once } from 'node:events';

                                                  const ee = new EventEmitter();
                                                  const ac = new AbortController();

                                                  async function foo(emitter, event, signal) {
                                                    try {
                                                      await once(emitter, event, { signal });
                                                      console.log('event emitted!');
                                                    } catch (error) {
                                                      if (error.name === 'AbortError') {
                                                        console.error('Waiting for the event was canceled!');
                                                      } else {
                                                        console.error('There was an error', error.message);
                                                      }
                                                    }
                                                  }

                                                  foo(ee, 'foo', ac.signal);
                                                  ac.abort(); // Abort waiting for the event
                                                  ee.emit('foo'); // Prints: Waiting for the event was canceled!
                                                  -

                                                  Parameters

                                                  Returns Promise<any[]>

                                                  v11.13.0, v10.16.0

                                                  -
                                                • import { setMaxListeners, EventEmitter } from 'node:events';

                                                  const target = new EventTarget();
                                                  const emitter = new EventEmitter();

                                                  setMaxListeners(5, target, emitter);
+

                                                  Parameters

                                                  Returns Promise<any[]>

                                                  v11.13.0, v10.16.0

                                                  +
                                                • import { setMaxListeners, EventEmitter } from 'node:events';

                                                  const target = new EventTarget();
                                                  const emitter = new EventEmitter();

                                                  setMaxListeners(5, target, emitter);

                                                  Parameters

                                                  • Optionaln: number

                                                    A non-negative number. The maximum number of listeners per EventTarget event.

                                                    -
                                                  • ...eventTargets: (EventEmitter<DefaultEventMap> | EventTarget)[]

                                                    Zero or more {EventTarget} or {EventEmitter} instances. If none are specified, n is set as the default max for all newly created {EventTarget} and {EventEmitter} +

                                                  • ...eventTargets: (EventEmitter<DefaultEventMap> | EventTarget)[]

                                                    Zero or more {EventTarget} or {EventEmitter} instances. If none are specified, n is set as the default max for all newly created {EventTarget} and {EventEmitter} objects.

                                                    -

                                                  Returns void

                                                  v15.4.0

                                                  -

                                                Settings

                                                Member Visibility

                                                On This Page

                                                Constructors
                                                Properties
                                                Methods
                                                +

                                                Returns void

                                                v15.4.0

                                                +

                                                Settings

                                                Member Visibility

                                                On This Page

                                                Constructors
                                                Properties
                                                Methods
                                                diff --git a/docs/classes/_internal_.Collection.html b/docs/classes/_internal_.Collection.html index 00adf1e8..7464ee9b 100644 --- a/docs/classes/_internal_.Collection.html +++ b/docs/classes/_internal_.Collection.html @@ -1,4 +1,4 @@ -Collection | ts-lambda-api - v2.5.2
                                                ts-lambda-api - v2.5.2
                                                  Preparing search index...

                                                  Class CollectionAbstract

                                                  Hierarchy (View Summary)

                                                  Index

                                                  Constructors

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

                                                    Class CollectionAbstract

                                                    Hierarchy (View Summary)

                                                    Index

                                                    Constructors

                                                    constructor

                                                    Properties

                                                    [NODE_TYPE] addToJSMap? anchor? @@ -28,40 +28,40 @@ toString

                                                    Constructors

                                                    Properties

                                                    "[NODE_TYPE]": symbol
                                                    addToJSMap?: (ctx: ToJSContext, map: MapLike, value: unknown) => void

                                                    Customize the way that a key-value pair is resolved. Used for YAML 1.1 !!merge << handling.

                                                    -
                                                    anchor?: string

                                                    An optional anchor on this node. Used by alias nodes.

                                                    -
                                                    comment?: string

                                                    A comment on or immediately after this

                                                    -
                                                    commentBefore?: string

                                                    A comment before this

                                                    -
                                                    flow?: boolean

                                                    If true, stringify this and all child nodes using flow rather than +

                                                    anchor?: string

                                                    An optional anchor on this node. Used by alias nodes.

                                                    +
                                                    comment?: string

                                                    A comment on or immediately after this

                                                    +
                                                    commentBefore?: string

                                                    A comment before this

                                                    +
                                                    flow?: boolean

                                                    If true, stringify this and all child nodes using flow rather than block styles.

                                                    -
                                                    items: unknown[]
                                                    range?: Range

                                                    The [start, value-end, node-end] character offsets for the part of the +

                                                    items: unknown[]
                                                    range?: Range

                                                    The [start, value-end, node-end] character offsets for the part of the source parsed into this node (undefined if not parsed). The value-end and node-end positions are themselves not included in their respective ranges.

                                                    -
                                                    schema: Schema
                                                    spaceBefore?: boolean

                                                    A blank line before this node and its commentBefore

                                                    -
                                                    srcToken?: Token

                                                    The CST token that was composed into this node.

                                                    -
                                                    tag?: string

                                                    A fully qualified tag, if required

                                                    -

                                                    Methods

                                                    • Adds a value to the collection.

                                                      -

                                                      Parameters

                                                      • value: unknown

                                                      Returns void

                                                    • Adds a value to the collection. For !!map and !!omap the value must +

                                                    schema: Schema
                                                    spaceBefore?: boolean

                                                    A blank line before this node and its commentBefore

                                                    +
                                                    srcToken?: Token

                                                    The CST token that was composed into this node.

                                                    +
                                                    tag?: string

                                                    A fully qualified tag, if required

                                                    +

                                                    Methods

                                                    • Adds a value to the collection.

                                                      +

                                                      Parameters

                                                      • value: unknown

                                                      Returns void

                                                    • Adds a value to the collection. For !!map and !!omap the value must be a Pair instance or a { key, value } object, which may not have a key that already exists in the map.

                                                      -

                                                      Parameters

                                                      Returns void

                                                    • Create a copy of this collection.

                                                      +

                                                      Parameters

                                                      Returns void

                                                    • Create a copy of this collection.

                                                      Parameters

                                                      • Optionalschema: Schema

                                                        If defined, overwrites the original's schema

                                                        -

                                                      Returns Collection

                                                    • Removes a value from the collection.

                                                      +

                                                    Returns Collection

                                                    • Removes a value from the collection.

                                                      Parameters

                                                      • key: unknown

                                                      Returns boolean

                                                      true if the item was found and removed.

                                                      -

                                                    • Removes a value from the collection.

                                                      +

                                                    • Removes a value from the collection.

                                                      Parameters

                                                      Returns boolean

                                                      true if the item was found and removed.

                                                      -

                                                    • Returns item at key, or undefined if not found. By default unwraps +

                                                    • Returns item at key, or undefined if not found. By default unwraps scalar values from their surrounding node; to disable set keepScalar to true (collections are always returned intact).

                                                      -

                                                      Parameters

                                                      • key: unknown
                                                      • OptionalkeepScalar: boolean

                                                      Returns unknown

                                                    • Returns item at key, or undefined if not found. By default unwraps +

                                                      Parameters

                                                      • key: unknown
                                                      • OptionalkeepScalar: boolean

                                                      Returns unknown

                                                    • Returns item at key, or undefined if not found. By default unwraps scalar values from their surrounding node; to disable set keepScalar to true (collections are always returned intact).

                                                      -

                                                      Parameters

                                                      • path: Iterable<unknown>
                                                      • OptionalkeepScalar: boolean

                                                      Returns unknown

                                                    • Checks if the collection includes a value with the key key.

                                                      -

                                                      Parameters

                                                      • key: unknown

                                                      Returns boolean

                                                    • Parameters

                                                      • OptionalallowScalar: boolean

                                                      Returns boolean

                                                    • Checks if the collection includes a value with the key key.

                                                      -

                                                      Parameters

                                                      Returns boolean

                                                    • Sets a value in this collection. For !!set, value needs to be a +

                                                      Parameters

                                                      • path: Iterable<unknown>
                                                      • OptionalkeepScalar: boolean

                                                      Returns unknown

                                                    • Checks if the collection includes a value with the key key.

                                                      +

                                                      Parameters

                                                      • key: unknown

                                                      Returns boolean

                                                    • Parameters

                                                      • OptionalallowScalar: boolean

                                                      Returns boolean

                                                    • Checks if the collection includes a value with the key key.

                                                      +

                                                      Parameters

                                                      Returns boolean

                                                    • Sets a value in this collection. For !!set, value needs to be a boolean to add/remove the item from the set.

                                                      -

                                                      Parameters

                                                      • key: unknown
                                                      • value: unknown

                                                      Returns void

                                                    • Sets a value in this collection. For !!set, value needs to be a +

                                                      Parameters

                                                      • key: unknown
                                                      • value: unknown

                                                      Returns void

                                                    • Sets a value in this collection. For !!set, value needs to be a boolean to add/remove the item from the set.

                                                      -

                                                      Parameters

                                                      Returns void

                                                    • A plain JavaScript representation of this node.

                                                      -

                                                      Parameters

                                                      Returns any

                                                    • A plain JS representation of this node

                                                      -

                                                      Returns any

                                                    • Parameters

                                                      • Optionalctx: StringifyContext
                                                      • OptionalonComment: () => void
                                                      • OptionalonChompKeep: () => void

                                                      Returns string

                                                    Settings

                                                    Member Visibility

                                                    On This Page

                                                    Constructors
                                                    Properties
                                                    Methods
                                                    +

                                                    Parameters

                                                    Returns void

                                                    • A plain JavaScript representation of this node.

                                                      +

                                                      Parameters

                                                      Returns any

                                                    • A plain JS representation of this node

                                                      +

                                                      Returns any

                                                    • Parameters

                                                      • Optionalctx: StringifyContext
                                                      • OptionalonComment: () => void
                                                      • OptionalonChompKeep: () => void

                                                      Returns string

                                                    Settings

                                                    Member Visibility

                                                    On This Page

                                                    Constructors
                                                    Properties
                                                    Methods
                                                    diff --git a/docs/classes/_internal_.Directives.html b/docs/classes/_internal_.Directives.html index 0e8ab456..8175d7f1 100644 --- a/docs/classes/_internal_.Directives.html +++ b/docs/classes/_internal_.Directives.html @@ -12,15 +12,15 @@ tagString toString

                                                    Constructors

                                                    • Parameters

                                                      • Optionalyaml: { explicit?: boolean; version: "1.1" | "1.2" | "next" }
                                                      • Optionaltags: Record<string, string>

                                                      Returns Directives

                                                    Properties

                                                    docEnd: boolean

                                                    The doc-end marker ....

                                                    -
                                                    docStart: true

                                                    The directives-end/doc-start marker ---. If null, a marker may still be +

                                                    docStart: true

                                                    The directives-end/doc-start marker ---. If null, a marker may still be included in the document's stringified representation.

                                                    -
                                                    tags: Record<string, string>
                                                    yaml: { explicit?: boolean; version: "1.1" | "1.2" | "next" }
                                                    defaultTags: Record<string, string>
                                                    defaultYaml: { explicit?: boolean; version: "1.1" | "1.2" | "next" }

                                                    Methods

                                                    • Parameters

                                                      • line: string
                                                      • onError: (offset: number, message: string, warning?: boolean) => void

                                                        May be called even if the action was successful

                                                        -

                                                      Returns boolean

                                                      true on success

                                                      -

                                                    • During parsing, get a Directives instance for the current document and +

                                                    tags: Record<string, string>
                                                    yaml: { explicit?: boolean; version: "1.1" | "1.2" | "next" }
                                                    defaultTags: Record<string, string>
                                                    defaultYaml: { explicit?: boolean; version: "1.1" | "1.2" | "next" }

                                                    Methods

                                                    • Parameters

                                                      • line: string
                                                      • onError: (offset: number, message: string, warning?: boolean) => void

                                                        May be called even if the action was successful

                                                        +

                                                      Returns boolean

                                                      true on success

                                                      +

                                                    • During parsing, get a Directives instance for the current document and update the stream state according to the current version's spec.

                                                      -

                                                      Returns Directives

                                                    • Resolves a tag, matching handles to those defined in %TAG directives.

                                                      +

                                                      Returns Directives

                                                    • Resolves a tag, matching handles to those defined in %TAG directives.

                                                      Parameters

                                                      • source: string
                                                      • onError: (message: string) => void

                                                      Returns string

                                                      Resolved tag, which may also be the non-specific tag '!' or a '!local' tag, or null if unresolvable.

                                                      -

                                                    • Given a fully resolved tag, returns its printable string form, +

                                                    • Given a fully resolved tag, returns its printable string form, taking into account current tag prefixes and defaults.

                                                      -

                                                      Parameters

                                                      • tag: string

                                                      Returns string

                                                    • Parameters

                                                      Returns string

                                                    Settings

                                                    Member Visibility

                                                    On This Page

                                                    Constructors
                                                    Properties
                                                    Methods
                                                    +

                                                    Parameters

                                                    • tag: string

                                                    Returns string

                                                    • Parameters

                                                      Returns string

                                                    Settings

                                                    Member Visibility

                                                    On This Page

                                                    Constructors
                                                    Properties
                                                    Methods
                                                    diff --git a/docs/classes/_internal_.Document.html b/docs/classes/_internal_.Document.html index 7cc1b851..e8d7f9d6 100644 --- a/docs/classes/_internal_.Document.html +++ b/docs/classes/_internal_.Document.html @@ -1,4 +1,4 @@ -Document | ts-lambda-api - v2.5.2
                                                    ts-lambda-api - v2.5.2
                                                      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.2
                                                      ts-lambda-api - v2.5.2
                                                        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 @@ -27,57 +27,57 @@ toJS toJSON toString -

                                                        Constructors

                                                        Constructors

                                                        Properties

                                                        "[NODE_TYPE]": symbol
                                                        comment: string

                                                        A comment immediately after this Document

                                                        -
                                                        commentBefore: string

                                                        A comment before this Document

                                                        -
                                                        contents: Strict extends true ? Contents : Contents

                                                        The document contents.

                                                        -
                                                        directives: Strict extends true ? Directives : Directives
                                                        errors: YAMLError[]

                                                        Errors encountered during parsing.

                                                        -
                                                        options: Required<
                                                            Omit<
                                                                ParseOptions & DocumentOptions,
                                                                "_directives"
                                                                | "lineCounter"
                                                                | "version",
                                                            >,
                                                        >
                                                        range?: Range

                                                        The [start, value-end, node-end] character offsets for the part of the +

                                                      • Optionaloptions: DocumentOptions & SchemaOptions & ParseOptions & CreateNodeOptions

                                                        • Returns Document<Contents, Strict>

                                                      • Type Parameters

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

                                                        Parameters

                                                        Returns Document<Contents, Strict>

                                                        • Properties

                                                        "[NODE_TYPE]": symbol
                                                        comment: string

                                                        A comment immediately after this Document

                                                        +
                                                        commentBefore: string

                                                        A comment before this Document

                                                        +
                                                        contents: Strict extends true ? Contents : Contents

                                                        The document contents.

                                                        +
                                                        directives: Strict extends true ? Directives : Directives
                                                        errors: YAMLError[]

                                                        Errors encountered during parsing.

                                                        +
                                                        options: Required<
                                                            Omit<
                                                                ParseOptions & DocumentOptions,
                                                                "_directives"
                                                                | "lineCounter"
                                                                | "version",
                                                            >,
                                                        >
                                                        range?: Range

                                                        The [start, value-end, node-end] character offsets for the part of the source parsed into this document (undefined if not parsed). The value-end and node-end positions are themselves not included in their respective ranges.

                                                        -
                                                        schema: Schema

                                                        The schema used with the document. Use setSchema() to change.

                                                        -
                                                        warnings: YAMLWarning[]

                                                        Warnings encountered during parsing.

                                                        -

                                                        Methods

                                                        • Adds a value to the document.

                                                          -

                                                          Parameters

                                                          • value: any

                                                          Returns void

                                                        • Adds a value to the document.

                                                          -

                                                          Parameters

                                                          Returns void

                                                        • Create a deep copy of this Document and its contents.

                                                          +
                                                        schema: Schema

                                                        The schema used with the document. Use setSchema() to change.

                                                        +
                                                        warnings: YAMLWarning[]

                                                        Warnings encountered during parsing.

                                                        +

                                                        Methods

                                                        • Adds a value to the document.

                                                          +

                                                          Parameters

                                                          • value: any

                                                          Returns void

                                                        • Adds a value to the document.

                                                          +

                                                          Parameters

                                                          Returns void

                                                        • Create a deep copy of this Document and its contents.

                                                          Custom Node values that inherit from Object still refer to their original instances.

                                                          -

                                                          Returns Document<Contents, Strict>

                                                        • Create a new Alias node, ensuring that the target node has the required anchor.

                                                          +

                                                          Returns Document<Contents, Strict>

                                                        • Create a new Alias node, ensuring that the target node has the required anchor.

                                                          If node already has an anchor, name is ignored. Otherwise, the node.anchor value will be set to name, or if an anchor with that name is already present in the document, name will be used as a prefix for a new unique anchor. If name is undefined, the generated anchor will use 'a' as a prefix.

                                                          -

                                                          Parameters

                                                          • node: Strict extends true
                                                                ? Scalar<unknown>
                                                                | YAMLMap<unknown, unknown>
                                                                | YAMLSeq<unknown>
                                                                : Node
                                                          • Optionalname: string

                                                          Returns Alias

                                                        • Convert any value into a Node using the current schema, recursively +

                                                          Parameters

                                                          • node: Strict extends true
                                                                ? Scalar<unknown>
                                                                | YAMLMap<unknown, unknown>
                                                                | YAMLSeq<unknown>
                                                                : Node
                                                          • Optionalname: string

                                                          Returns Alias

                                                        • Convert a key and a value into a Pair using the current schema, recursively wrapping all values as Scalar or Collection nodes.

                                                          -

                                                          Type Parameters

                                                          Parameters

                                                          Returns Pair<K, V>

                                                        • Removes a value from the document.

                                                          +

                                                          Type Parameters

                                                          Parameters

                                                          Returns Pair<K, V>

                                                        • Removes a value from the document.

                                                          Parameters

                                                          • key: unknown

                                                          Returns boolean

                                                          true if the item was found and removed.

                                                          -

                                                        • Removes a value from the document.

                                                          +

                                                        • Removes a value from the document.

                                                          Parameters

                                                          Returns boolean

                                                          true if the item was found and removed.

                                                          -

                                                        • Returns item at key, or undefined if not found. By default unwraps +

                                                        • Returns item at key, or undefined if not found. By default unwraps scalar values from their surrounding node; to disable set keepScalar to true (collections are always returned intact).

                                                          -

                                                          Parameters

                                                          • key: unknown
                                                          • OptionalkeepScalar: boolean

                                                          Returns Strict extends true ? unknown : any

                                                        • Returns item at path, or undefined if not found. By default unwraps +

                                                          Parameters

                                                          • key: unknown
                                                          • OptionalkeepScalar: boolean

                                                          Returns Strict extends true ? unknown : any

                                                        • Returns item at path, or undefined if not found. By default unwraps scalar values from their surrounding node; to disable set keepScalar to true (collections are always returned intact).

                                                          -

                                                          Parameters

                                                          • path: Iterable<unknown, any, any>
                                                          • OptionalkeepScalar: boolean

                                                          Returns Strict extends true ? unknown : any

                                                        • Checks if the document includes a value with the key key.

                                                          -

                                                          Parameters

                                                          • key: unknown

                                                          Returns boolean

                                                        • Checks if the document includes a value at path.

                                                          -

                                                          Parameters

                                                          Returns boolean

                                                        • Sets a value in this document. For !!set, value needs to be a +

                                                          Parameters

                                                          • path: Iterable<unknown, any, any>
                                                          • OptionalkeepScalar: boolean

                                                          Returns Strict extends true ? unknown : any

                                                        • Checks if the document includes a value with the key key.

                                                          +

                                                          Parameters

                                                          • key: unknown

                                                          Returns boolean

                                                        • Checks if the document includes a value at path.

                                                          +

                                                          Parameters

                                                          Returns boolean

                                                        • Sets a value in this document. For !!set, value needs to be a boolean to add/remove the item from the set.

                                                          -

                                                          Parameters

                                                          • key: any
                                                          • value: unknown

                                                          Returns void

                                                        • Sets a value in this document. For !!set, value needs to be a +

                                                          Parameters

                                                          • key: any
                                                          • value: unknown

                                                          Returns void

                                                        • Sets a value in this document. For !!set, value needs to be a boolean to add/remove the item from the set.

                                                          -

                                                          Parameters

                                                          • path: Iterable<unknown, any, any>
                                                          • value: unknown

                                                          Returns void

                                                        • Change the YAML version and schema used by the document. +

                                                          Parameters

                                                          • path: Iterable<unknown, any, any>
                                                          • value: unknown

                                                          Returns void

                                                        • Change the YAML version and schema used by the document. A null version disables support for directives, explicit tags, anchors, and aliases. It also requires the schema option to be given as a Schema instance value.

                                                          Overrides all previously set schema options.

                                                          -

                                                          Parameters

                                                          Returns void

                                                        • A plain JavaScript representation of the document contents.

                                                          -

                                                          Parameters

                                                          • Optionalopt: ToJSOptions & { [ignored: string]: unknown }

                                                          Returns any

                                                        • A JSON representation of the document contents.

                                                          +

                                                          Parameters

                                                          Returns void

                                                        • A plain JavaScript representation of the document contents.

                                                          +

                                                          Parameters

                                                          • Optionalopt: ToJSOptions & { [ignored: string]: unknown }

                                                          Returns any

                                                        • A JSON representation of the document contents.

                                                          Parameters

                                                          • OptionaljsonArg: string

                                                            Used by JSON.stringify to indicate the array index or property name.

                                                            -
                                                          • OptionalonAnchor: (value: unknown, count: number) => void

                                                          Returns any

                                                        • A YAML representation of the document.

                                                          -

                                                          Parameters

                                                          Returns string

                                                        Settings

                                                        Member Visibility

                                                        On This Page

                                                        Constructors
                                                        Properties
                                                        Methods
                                                        +
                                                      • OptionalonAnchor: (value: unknown, count: number) => void

                                                        • Returns any

                                                        • A YAML representation of the document.

                                                          +

                                                          Parameters

                                                          Returns string

                                                        Settings

                                                        Member Visibility

                                                        On This Page

                                                        Constructors
                                                        Properties
                                                        Methods
                                                        diff --git a/docs/classes/_internal_.EventEmitter.EventEmitterAsyncResource.html b/docs/classes/_internal_.EventEmitter.EventEmitterAsyncResource.html index 460fb4f2..201cadfd 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 @@ -40,17 +40,17 @@ once setMaxListeners

                                                        Constructors

                                                        Properties

                                                        asyncId: number

                                                        The unique asyncId assigned to the resource.

                                                        -
                                                        asyncResource: EventEmitterReferencingAsyncResource

                                                        The returned AsyncResource object has an additional eventEmitter property +

                                                        Returns EventEmitterAsyncResource

                                                        Properties

                                                        asyncId: number

                                                        The unique asyncId assigned to the resource.

                                                        +
                                                        asyncResource: EventEmitterReferencingAsyncResource

                                                        The returned AsyncResource object has an additional eventEmitter property that provides a reference to this EventEmitterAsyncResource.

                                                        -
                                                        triggerAsyncId: number

                                                        The same triggerAsyncId that is passed to the AsyncResource constructor.

                                                        -
                                                        captureRejections: boolean

                                                        Value: boolean

                                                        +
                                                        triggerAsyncId: number

                                                        The same triggerAsyncId that is passed to the AsyncResource constructor.

                                                        +
                                                        captureRejections: boolean

                                                        Value: boolean

                                                        Change the default captureRejections option on all new EventEmitter objects.

                                                        v13.4.0, v12.16.0

                                                        -
                                                        captureRejectionSymbol: typeof captureRejectionSymbol

                                                        Value: Symbol.for('nodejs.rejection')

                                                        +
                                                        captureRejectionSymbol: typeof captureRejectionSymbol

                                                        Value: Symbol.for('nodejs.rejection')

                                                        See how to write a custom rejection handler.

                                                        v13.4.0, v12.16.0

                                                        -
                                                        defaultMaxListeners: number

                                                        By default, a maximum of 10 listeners can be registered for any single +

                                                        defaultMaxListeners: number

                                                        By default, a maximum of 10 listeners can be registered for any single event. This limit can be changed for individual EventEmitter instances using the emitter.setMaxListeners(n) method. To change the default for allEventEmitter instances, the events.defaultMaxListeners property @@ -75,46 +75,46 @@ listeners, respectively. Its name property is set to 'MaxListenersExceededWarning'.

                                                        v0.11.2

                                                        -
                                                        errorMonitor: typeof errorMonitor

                                                        This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

                                                        +
                                                        errorMonitor: typeof errorMonitor

                                                        This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

                                                        Installing a listener using this symbol does not change the behavior once an 'error' event is emitted. Therefore, the process will still crash if no regular 'error' listener is installed.

                                                        v13.6.0, v12.17.0

                                                        -

                                                        Methods

                                                        • Type Parameters

                                                          • K

                                                          Parameters

                                                          • error: Error
                                                          • event: string | symbol
                                                          • ...args: AnyRest

                                                          Returns void

                                                        • Alias for emitter.on(eventName, listener).

                                                          +

                                                        Methods

                                                        • Type Parameters

                                                          • K

                                                          Parameters

                                                          • error: Error
                                                          • event: string | symbol
                                                          • ...args: AnyRest

                                                          Returns void

                                                        • Alias for emitter.on(eventName, listener).

                                                          Type Parameters

                                                          • K

                                                          Parameters

                                                          • eventName: string | symbol
                                                          • listener: (...args: any[]) => void

                                                          Returns this

                                                          v0.1.26

                                                          -

                                                        • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments +

                                                        • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

                                                          Returns true if the event had listeners, false otherwise.

                                                          import { EventEmitter } from 'node:events';
                                                          const myEmitter = new EventEmitter();

                                                          // First listener
                                                          myEmitter.on('event', function firstListener() {
                                                            console.log('Helloooo! first listener');
                                                          });
                                                          // Second listener
                                                          myEmitter.on('event', function secondListener(arg1, arg2) {
                                                            console.log(`event with parameters ${arg1}, ${arg2} in second listener`);
                                                          });
                                                          // Third listener
                                                          myEmitter.on('event', function thirdListener(...args) {
                                                            const parameters = args.join(', ');
                                                            console.log(`event with parameters ${parameters} in third listener`);
                                                          });

                                                          console.log(myEmitter.listeners('event'));

                                                          myEmitter.emit('event', 1, 2, 3, 4, 5);

                                                          // Prints:
                                                          // [
                                                          //   [Function: firstListener],
                                                          //   [Function: secondListener],
                                                          //   [Function: thirdListener]
                                                          // ]
                                                          // Helloooo! first listener
                                                          // event with parameters 1, 2 in second listener
                                                          // event with parameters 1, 2, 3, 4, 5 in third listener

                                                          Type Parameters

                                                          • K

                                                          Parameters

                                                          • eventName: string | symbol
                                                          • ...args: AnyRest

                                                          Returns boolean

                                                          v0.1.26

                                                          -

                                                        • Call all destroy hooks. This should only ever be called once. An error will +

                                                        • Call all destroy hooks. This should only ever be called once. An error will be thrown if it is called more than once. This must be manually called. If the resource is left to be collected by the GC then the destroy hooks will never be called.

                                                          -

                                                          Returns void

                                                        • Returns an array listing the events for which the emitter has registered +

                                                          Returns void

                                                        • Returns an array listing the events for which the emitter has registered listeners. The values in the array are strings or Symbols.

                                                          import { EventEmitter } from 'node:events';

                                                          const myEE = new EventEmitter();
                                                          myEE.on('foo', () => {});
                                                          myEE.on('bar', () => {});

                                                          const sym = Symbol('symbol');
                                                          myEE.on(sym, () => {});

                                                          console.log(myEE.eventNames());
                                                          // Prints: [ 'foo', 'bar', Symbol(symbol) ]

                                                          Returns (string | symbol)[]

                                                          v6.0.0

                                                          -

                                                        • Returns the current max listener value for the EventEmitter which is either +

                                                        • Returns the current max listener value for the EventEmitter which is either set by emitter.setMaxListeners(n) or defaults to EventEmitter.defaultMaxListeners.

                                                          Returns number

                                                          v1.0.0

                                                          -

                                                        • Returns the number of listeners listening for the event named eventName. +

                                                        • Returns the number of listeners listening for the event named eventName. If listener is provided, it will return how many times the listener is found in the list of the listeners of the event.

                                                          Type Parameters

                                                          • K

                                                          Parameters

                                                          • eventName: string | symbol

                                                            The name of the event being listened for

                                                            -
                                                          • Optionallistener: Function

                                                            The event handler function

                                                            -

                                                          Returns number

                                                          v3.2.0

                                                          -

                                                        • Returns a copy of the array of listeners for the event named eventName.

                                                          +
                                                        • Optionallistener: Function

                                                          The event handler function

                                                          +

                                                        Returns number

                                                        v3.2.0

                                                        +

                                                        • Returns a copy of the array of listeners for the event named eventName.

                                                          server.on('connection', (stream) => {
                                                            console.log('someone connected!');
                                                          });
                                                          console.log(util.inspect(server.listeners('connection')));
                                                          // Prints: [ [Function] ]

                                                          Type Parameters

                                                          • K

                                                          Parameters

                                                          • eventName: string | symbol

                                                          Returns Function[]

                                                          v0.1.26

                                                          -

                                                        • Alias for emitter.removeListener().

                                                          +

                                                        • Alias for emitter.removeListener().

                                                          Type Parameters

                                                          • K

                                                          Parameters

                                                          • eventName: string | symbol
                                                          • listener: (...args: any[]) => void

                                                          Returns this

                                                          v10.0.0

                                                          -

                                                        • Adds the listener function to the end of the listeners array for the event +

                                                        • Adds the listener function to the end of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.

                                                          @@ -128,9 +128,9 @@

                                                          Type Parameters

                                                          • K

                                                          Parameters

                                                          • eventName: string | symbol

                                                            The name of the event.

                                                            -
                                                          • listener: (...args: any[]) => void

                                                            The callback function

                                                            -

                                                          Returns this

                                                          v0.1.101

                                                          -

                                                        • Adds a one-time listener function for the event named eventName. The +

                                                        • listener: (...args: any[]) => void

                                                          The callback function

                                                          +

                                                        Returns this

                                                        v0.1.101

                                                        +

                                                        • Adds a one-time listener function for the event named eventName. The next time eventName is triggered, this listener is removed and then invoked.

                                                          server.once('connection', (stream) => {
                                                            console.log('Ah, we have our first user!');
                                                          });
                                                          @@ -142,9 +142,9 @@

                                                          Type Parameters

                                                          • K

                                                          Parameters

                                                          • eventName: string | symbol

                                                            The name of the event.

                                                            -
                                                          • listener: (...args: any[]) => void

                                                            The callback function

                                                            -

                                                          Returns this

                                                          v0.3.0

                                                          -

                                                        • Adds the listener function to the beginning of the listeners array for the +

                                                        • listener: (...args: any[]) => void

                                                          The callback function

                                                          +

                                                        Returns this

                                                        v0.3.0

                                                        +

                                                        • Adds the listener function to the beginning of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.

                                                          @@ -153,30 +153,30 @@

                                                          Returns a reference to the EventEmitter, so that calls can be chained.

                                                          Type Parameters

                                                          • K

                                                          Parameters

                                                          • eventName: string | symbol

                                                            The name of the event.

                                                            -
                                                          • listener: (...args: any[]) => void

                                                            The callback function

                                                            -

                                                          Returns this

                                                          v6.0.0

                                                          -

                                                        • Adds a one-timelistener function for the event named eventName to the beginning of the listeners array. The next time eventName is triggered, this +

                                                        • listener: (...args: any[]) => void

                                                          The callback function

                                                          +

                                                        Returns this

                                                        v6.0.0

                                                        +

                                                        • Adds a one-timelistener function for the event named eventName to the beginning of the listeners array. The next time eventName is triggered, this listener is removed, and then invoked.

                                                          server.prependOnceListener('connection', (stream) => {
                                                            console.log('Ah, we have our first user!');
                                                          });

                                                          Returns a reference to the EventEmitter, so that calls can be chained.

                                                          Type Parameters

                                                          • K

                                                          Parameters

                                                          • eventName: string | symbol

                                                            The name of the event.

                                                            -
                                                          • listener: (...args: any[]) => void

                                                            The callback function

                                                            -

                                                          Returns this

                                                          v6.0.0

                                                          -

                                                        • Returns a copy of the array of listeners for the event named eventName, +

                                                        • listener: (...args: any[]) => void

                                                          The callback function

                                                          +

                                                        Returns this

                                                        v6.0.0

                                                        +

                                                        • Returns a copy of the array of listeners for the event named eventName, including any wrappers (such as those created by .once()).

                                                          import { EventEmitter } from 'node:events';
                                                          const emitter = new EventEmitter();
                                                          emitter.once('log', () => console.log('log once'));

                                                          // Returns a new Array with a function `onceWrapper` which has a property
                                                          // `listener` which contains the original listener bound above
                                                          const listeners = emitter.rawListeners('log');
                                                          const logFnWrapper = listeners[0];

                                                          // Logs "log once" to the console and does not unbind the `once` event
                                                          logFnWrapper.listener();

                                                          // Logs "log once" to the console and removes the listener
                                                          logFnWrapper();

                                                          emitter.on('log', () => console.log('log persistently'));
                                                          // Will return a new Array with a single function bound by `.on()` above
                                                          const newListeners = emitter.rawListeners('log');

                                                          // Logs "log persistently" twice
                                                          newListeners[0]();
                                                          emitter.emit('log');

                                                          Type Parameters

                                                          • K

                                                          Parameters

                                                          • eventName: string | symbol

                                                          Returns Function[]

                                                          v9.4.0

                                                          -

                                                        • Removes all listeners, or those of the specified eventName.

                                                          +

                                                        • Removes all listeners, or those of the specified eventName.

                                                          It is bad practice to remove listeners added elsewhere in the code, particularly when the EventEmitter instance was created by some other component or module (e.g. sockets or file streams).

                                                          Returns a reference to the EventEmitter, so that calls can be chained.

                                                          Parameters

                                                          • OptionaleventName: string | symbol

                                                          Returns this

                                                          v0.1.26

                                                          -

                                                        • Removes the specified listener from the listener array for the event named eventName.

                                                          +

                                                        • Removes the specified listener from the listener array for the event named eventName.

                                                          const callback = (stream) => {
                                                            console.log('someone connected!');
                                                          };
                                                          server.on('connection', callback);
                                                          // ...
                                                          server.removeListener('connection', callback);
                                                          @@ -203,13 +203,13 @@

                                                          Returns a reference to the EventEmitter, so that calls can be chained.

                                                          Type Parameters

                                                          • K

                                                          Parameters

                                                          • eventName: string | symbol
                                                          • listener: (...args: any[]) => void

                                                          Returns this

                                                          v0.1.26

                                                          -

                                                        • By default EventEmitters will print a warning if more than 10 listeners are +

                                                        • By default EventEmitters will print a warning if more than 10 listeners are added for a particular event. This is a useful default that helps finding memory leaks. The emitter.setMaxListeners() method allows the limit to be modified for this specific EventEmitter instance. The value can be set to Infinity (or 0) to indicate an unlimited number of listeners.

                                                          Returns a reference to the EventEmitter, so that calls can be chained.

                                                          Parameters

                                                          • n: number

                                                          Returns this

                                                          v0.3.5

                                                          -

                                                        • Listens once to the abort event on the provided signal.

                                                          +

                                                        • Listens once to the abort event on the provided signal.

                                                          Listening to the abort event on abort signals is unsafe and may lead to resource leaks since another third party with the signal can call e.stopImmediatePropagation(). Unfortunately Node.js cannot change @@ -224,7 +224,7 @@

                                                          Parameters

                                                          Returns Disposable

                                                          Disposable that removes the abort listener.

                                                          v20.5.0

                                                          -

                                                        • Returns a copy of the array of listeners for the event named eventName.

                                                          For EventEmitters this behaves exactly the same as calling .listeners on the emitter.

                                                          For EventTargets this is the only way to get the event listeners for the @@ -233,7 +233,7 @@

                                                          Parameters

                                                          Returns Function[]

                                                          v15.2.0, v14.17.0

                                                          -

                                                        • A class method that returns the number of listeners for the given eventName registered on the given emitter.

                                                          +

                                                        • A class method that returns the number of listeners for the given eventName registered on the given emitter.

                                                          import { EventEmitter, listenerCount } from 'node:events';

                                                          const myEmitter = new EventEmitter();
                                                          myEmitter.on('event', () => {});
                                                          myEmitter.on('event', () => {});
                                                          console.log(listenerCount(myEmitter, 'event'));
                                                          // Prints: 2

                                                          Parameters

                                                          • emitter: EventEmitter

                                                            The emitter to query

                                                            -
                                                          • eventName: string | symbol

                                                            The event name

                                                            -

                                                          Returns number

                                                          v0.9.12

                                                          +
                                                        • eventName: string | symbol

                                                          The event name

                                                          +

                                                        Returns number

                                                        v0.9.12

                                                        Since v3.2.0 - Use listenerCount instead.

                                                        -
                                                        • import { on, EventEmitter } from 'node:events';
                                                          import process from 'node:process';

                                                          const ee = new EventEmitter();

                                                          // Emit later on
                                                          process.nextTick(() => {
                                                            ee.emit('foo', 'bar');
                                                            ee.emit('foo', 42);
                                                          });

                                                          for await (const event of on(ee, 'foo')) {
                                                            // The execution of this inner block is synchronous and it
                                                            // processes one event at a time (even with await). Do not use
                                                            // if concurrent execution is required.
                                                            console.log(event); // prints ['bar'] [42]
                                                          }
                                                          // Unreachable here
+
                                                        • import { on, EventEmitter } from 'node:events';
                                                          import process from 'node:process';

                                                          const ee = new EventEmitter();

                                                          // Emit later on
                                                          process.nextTick(() => {
                                                            ee.emit('foo', 'bar');
                                                            ee.emit('foo', 42);
                                                          });

                                                          for await (const event of on(ee, 'foo')) {
                                                            // The execution of this inner block is synchronous and it
                                                            // processes one event at a time (even with await). Do not use
                                                            // if concurrent execution is required.
                                                            console.log(event); // prints ['bar'] [42]
                                                          }
                                                          // Unreachable here

                                                          Returns an AsyncIterator that iterates eventName events. It will throw @@ -268,7 +268,7 @@

                                                          Parameters

                                                          Returns AsyncIterator<any[]>

                                                          An AsyncIterator that iterates eventName events emitted by the emitter

                                                          v13.6.0, v12.16.0

                                                          -
                                                        • import { on, EventEmitter } from 'node:events';
                                                          import process from 'node:process';

                                                          const ee = new EventEmitter();

                                                          // Emit later on
                                                          process.nextTick(() => {
                                                            ee.emit('foo', 'bar');
                                                            ee.emit('foo', 42);
                                                          });

                                                          for await (const event of on(ee, 'foo')) {
                                                            // The execution of this inner block is synchronous and it
                                                            // processes one event at a time (even with await). Do not use
                                                            // if concurrent execution is required.
                                                            console.log(event); // prints ['bar'] [42]
                                                          }
                                                          // Unreachable here
+
                                                        • import { on, EventEmitter } from 'node:events';
                                                          import process from 'node:process';

                                                          const ee = new EventEmitter();

                                                          // Emit later on
                                                          process.nextTick(() => {
                                                            ee.emit('foo', 'bar');
                                                            ee.emit('foo', 42);
                                                          });

                                                          for await (const event of on(ee, 'foo')) {
                                                            // The execution of this inner block is synchronous and it
                                                            // processes one event at a time (even with await). Do not use
                                                            // if concurrent execution is required.
                                                            console.log(event); // prints ['bar'] [42]
                                                          }
                                                          // Unreachable here

                                                          Returns an AsyncIterator that iterates eventName events. It will throw @@ -285,7 +285,7 @@

                                                          Parameters

                                                          Returns AsyncIterator<any[]>

                                                          An AsyncIterator that iterates eventName events emitted by the emitter

                                                          v13.6.0, v12.16.0

                                                          -

                                                        • Creates a Promise that is fulfilled when the EventEmitter emits the given +

                                                        • Creates a Promise that is fulfilled when the EventEmitter emits the given event or that is rejected if the EventEmitter emits 'error' while waiting. The Promise will resolve with an array of all the arguments emitted to the given event.

                                                          @@ -305,7 +305,7 @@

                                                          Parameters

                                                          Returns Promise<any[]>

                                                          v11.13.0, v10.16.0

                                                          -

                                                        • Creates a Promise that is fulfilled when the EventEmitter emits the given +

                                                        • Creates a Promise that is fulfilled when the EventEmitter emits the given event or that is rejected if the EventEmitter emits 'error' while waiting. The Promise will resolve with an array of all the arguments emitted to the given event.

                                                          @@ -325,11 +325,11 @@

                                                          Parameters

                                                          Returns Promise<any[]>

                                                          v11.13.0, v10.16.0

                                                          -
                                                        • import { setMaxListeners, EventEmitter } from 'node:events';

                                                          const target = new EventTarget();
                                                          const emitter = new EventEmitter();

                                                          setMaxListeners(5, target, emitter);
+
                                                        • import { setMaxListeners, EventEmitter } from 'node:events';

                                                          const target = new EventTarget();
                                                          const emitter = new EventEmitter();

                                                          setMaxListeners(5, target, emitter);

                                                          Parameters

                                                          • Optionaln: number

                                                            A non-negative number. The maximum number of listeners per EventTarget event.

                                                            -
                                                          • ...eventTargets: (EventEmitter<DefaultEventMap> | EventTarget)[]

                                                            Zero or more {EventTarget} or {EventEmitter} instances. If none are specified, n is set as the default max for all newly created {EventTarget} and {EventEmitter} +

                                                          • ...eventTargets: (EventEmitter<DefaultEventMap> | EventTarget)[]

                                                            Zero or more {EventTarget} or {EventEmitter} instances. If none are specified, n is set as the default max for all newly created {EventTarget} and {EventEmitter} objects.

                                                            -

                                                          Returns void

                                                          v15.4.0

                                                          -

                                                        Settings

                                                        Member Visibility

                                                        On This Page

                                                        Constructors
                                                        Properties
                                                        Methods
                                                        +

                                                        Returns void

                                                        v15.4.0

                                                        +

                                                        Settings

                                                        Member Visibility

                                                        On This Page

                                                        Constructors
                                                        Properties
                                                        Methods
                                                        diff --git a/docs/classes/_internal_.EventEmitter.html b/docs/classes/_internal_.EventEmitter.html index d350fdeb..62f498f4 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 @@ -34,13 +34,13 @@ on once setMaxListeners -

                                                        Constructors

                                                        Properties

                                                        captureRejections: boolean

                                                        Value: boolean

                                                        +

                                                        Constructors

                                                        Properties

                                                        captureRejections: boolean

                                                        Value: boolean

                                                        Change the default captureRejections option on all new EventEmitter objects.

                                                        v13.4.0, v12.16.0

                                                        -
                                                        captureRejectionSymbol: typeof captureRejectionSymbol

                                                        Value: Symbol.for('nodejs.rejection')

                                                        +
                                                        captureRejectionSymbol: typeof captureRejectionSymbol

                                                        Value: Symbol.for('nodejs.rejection')

                                                        See how to write a custom rejection handler.

                                                        v13.4.0, v12.16.0

                                                        -
                                                        defaultMaxListeners: number

                                                        By default, a maximum of 10 listeners can be registered for any single +

                                                        defaultMaxListeners: number

                                                        By default, a maximum of 10 listeners can be registered for any single event. This limit can be changed for individual EventEmitter instances using the emitter.setMaxListeners(n) method. To change the default for allEventEmitter instances, the events.defaultMaxListeners property @@ -65,42 +65,42 @@ listeners, respectively. Its name property is set to 'MaxListenersExceededWarning'.

                                                        v0.11.2

                                                        -
                                                        errorMonitor: typeof errorMonitor

                                                        This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

                                                        +
                                                        errorMonitor: typeof errorMonitor

                                                        This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

                                                        Installing a listener using this symbol does not change the behavior once an 'error' event is emitted. Therefore, the process will still crash if no regular 'error' listener is installed.

                                                        v13.6.0, v12.17.0

                                                        -

                                                        Methods

                                                        • Type Parameters

                                                          • K

                                                          Parameters

                                                          Returns void

                                                        • Alias for emitter.on(eventName, listener).

                                                          -

                                                          Type Parameters

                                                          • K

                                                          Parameters

                                                          Returns this

                                                          v0.1.26

                                                          -

                                                        • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments +

                                                        Methods

                                                        • Type Parameters

                                                          • K

                                                          Parameters

                                                          Returns void

                                                        • Alias for emitter.on(eventName, listener).

                                                          +

                                                          Type Parameters

                                                          • K

                                                          Parameters

                                                          Returns this

                                                          v0.1.26

                                                          +

                                                        • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

                                                          Returns true if the event had listeners, false otherwise.

                                                          import { EventEmitter } from 'node:events';
                                                          const myEmitter = new EventEmitter();

                                                          // First listener
                                                          myEmitter.on('event', function firstListener() {
                                                            console.log('Helloooo! first listener');
                                                          });
                                                          // Second listener
                                                          myEmitter.on('event', function secondListener(arg1, arg2) {
                                                            console.log(`event with parameters ${arg1}, ${arg2} in second listener`);
                                                          });
                                                          // Third listener
                                                          myEmitter.on('event', function thirdListener(...args) {
                                                            const parameters = args.join(', ');
                                                            console.log(`event with parameters ${parameters} in third listener`);
                                                          });

                                                          console.log(myEmitter.listeners('event'));

                                                          myEmitter.emit('event', 1, 2, 3, 4, 5);

                                                          // Prints:
                                                          // [
                                                          //   [Function: firstListener],
                                                          //   [Function: secondListener],
                                                          //   [Function: thirdListener]
                                                          // ]
                                                          // Helloooo! first listener
                                                          // event with parameters 1, 2 in second listener
                                                          // event with parameters 1, 2, 3, 4, 5 in third listener
                                                          -

                                                          Type Parameters

                                                          • K

                                                          Parameters

                                                          Returns boolean

                                                          v0.1.26

                                                          -

                                                        • Returns an array listing the events for which the emitter has registered +

                                                          Type Parameters

                                                          • K

                                                          Parameters

                                                          Returns boolean

                                                          v0.1.26

                                                          +

                                                        • Returns an array listing the events for which the emitter has registered listeners. The values in the array are strings or Symbols.

                                                          import { EventEmitter } from 'node:events';

                                                          const myEE = new EventEmitter();
                                                          myEE.on('foo', () => {});
                                                          myEE.on('bar', () => {});

                                                          const sym = Symbol('symbol');
                                                          myEE.on(sym, () => {});

                                                          console.log(myEE.eventNames());
                                                          // Prints: [ 'foo', 'bar', Symbol(symbol) ]
                                                          -

                                                          Returns ((string | symbol) & Key2<unknown, T>)[]

                                                          v6.0.0

                                                          -

                                                        • Returns the current max listener value for the EventEmitter which is either +

                                                          Returns ((string | symbol) & Key2<unknown, T>)[]

                                                          v6.0.0

                                                          +

                                                        • Returns the current max listener value for the EventEmitter which is either set by emitter.setMaxListeners(n) or defaults to EventEmitter.defaultMaxListeners.

                                                          Returns number

                                                          v1.0.0

                                                          -

                                                        • Returns the number of listeners listening for the event named eventName. +

                                                        • Returns the number of listeners listening for the event named eventName. If listener is provided, it will return how many times the listener is found in the list of the listeners of the event.

                                                          -

                                                          Type Parameters

                                                          • K

                                                          Parameters

                                                          • eventName: Key<K, T>

                                                            The name of the event being listened for

                                                            -
                                                          • Optionallistener: Listener<K, T>

                                                            The event handler function

                                                            -

                                                          Returns number

                                                          v3.2.0

                                                          -

                                                        • Returns a copy of the array of listeners for the event named eventName.

                                                          +

                                                          Type Parameters

                                                          • K

                                                          Parameters

                                                          • eventName: Key<K, T>

                                                            The name of the event being listened for

                                                            +
                                                          • Optionallistener: Listener<K, T>

                                                            The event handler function

                                                            +

                                                          Returns number

                                                          v3.2.0

                                                          +

                                                        • Returns a copy of the array of listeners for the event named eventName.

                                                          server.on('connection', (stream) => {
                                                            console.log('someone connected!');
                                                          });
                                                          console.log(util.inspect(server.listeners('connection')));
                                                          // Prints: [ [Function] ]
                                                          -

                                                          Type Parameters

                                                          • K

                                                          Parameters

                                                          Returns Listener<K, T, Function>[]

                                                          v0.1.26

                                                          -

                                                        • Alias for emitter.removeListener().

                                                          -

                                                          Type Parameters

                                                          • K

                                                          Parameters

                                                          Returns this

                                                          v10.0.0

                                                          -

                                                        • Adds the listener function to the end of the listeners array for the event +

                                                          Type Parameters

                                                          • K

                                                          Parameters

                                                          Returns Listener<K, T, Function>[]

                                                          v0.1.26

                                                          +

                                                        • Alias for emitter.removeListener().

                                                          +

                                                          Type Parameters

                                                          • K

                                                          Parameters

                                                          Returns this

                                                          v10.0.0

                                                          +

                                                        • Adds the listener function to the end of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.

                                                          @@ -113,10 +113,10 @@ 
                                                          import { EventEmitter } from 'node:events';
                                                          const myEE = new EventEmitter();
                                                          myEE.on('foo', () => console.log('a'));
                                                          myEE.prependListener('foo', () => console.log('b'));
                                                          myEE.emit('foo');
                                                          // Prints:
                                                          //   b
                                                          //   a
                                                          -

                                                          Type Parameters

                                                          • K

                                                          Parameters

                                                          • eventName: Key<K, T>

                                                            The name of the event.

                                                            -
                                                          • listener: Listener<K, T>

                                                            The callback function

                                                            -

                                                          Returns this

                                                          v0.1.101

                                                          -

                                                        • Adds a one-time listener function for the event named eventName. The +

                                                          Type Parameters

                                                          • K

                                                          Parameters

                                                          • eventName: Key<K, T>

                                                            The name of the event.

                                                            +
                                                          • listener: Listener<K, T>

                                                            The callback function

                                                            +

                                                          Returns this

                                                          v0.1.101

                                                          +

                                                        • Adds a one-time listener function for the event named eventName. The next time eventName is triggered, this listener is removed and then invoked.

                                                          server.once('connection', (stream) => {
                                                            console.log('Ah, we have our first user!');
                                                          });
                                                          @@ -127,10 +127,10 @@ 
                                                          import { EventEmitter } from 'node:events';
                                                          const myEE = new EventEmitter();
                                                          myEE.once('foo', () => console.log('a'));
                                                          myEE.prependOnceListener('foo', () => console.log('b'));
                                                          myEE.emit('foo');
                                                          // Prints:
                                                          //   b
                                                          //   a
                                                          -

                                                          Type Parameters

                                                          • K

                                                          Parameters

                                                          • eventName: Key<K, T>

                                                            The name of the event.

                                                            -
                                                          • listener: Listener<K, T>

                                                            The callback function

                                                            -

                                                          Returns this

                                                          v0.3.0

                                                          -

                                                        • Adds the listener function to the beginning of the listeners array for the +

                                                          Type Parameters

                                                          • K

                                                          Parameters

                                                          • eventName: Key<K, T>

                                                            The name of the event.

                                                            +
                                                          • listener: Listener<K, T>

                                                            The callback function

                                                            +

                                                          Returns this

                                                          v0.3.0

                                                          +

                                                        • Adds the listener function to the beginning of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.

                                                          @@ -138,31 +138,31 @@

                                                          Returns a reference to the EventEmitter, so that calls can be chained.

                                                          -

                                                          Type Parameters

                                                          • K

                                                          Parameters

                                                          • eventName: Key<K, T>

                                                            The name of the event.

                                                            -
                                                          • listener: Listener<K, T>

                                                            The callback function

                                                            -

                                                          Returns this

                                                          v6.0.0

                                                          -

                                                        • Adds a one-timelistener function for the event named eventName to the beginning of the listeners array. The next time eventName is triggered, this +

                                                          Type Parameters

                                                          • K

                                                          Parameters

                                                          • eventName: Key<K, T>

                                                            The name of the event.

                                                            +
                                                          • listener: Listener<K, T>

                                                            The callback function

                                                            +

                                                          Returns this

                                                          v6.0.0

                                                          +

                                                        • Adds a one-timelistener function for the event named eventName to the beginning of the listeners array. The next time eventName is triggered, this listener is removed, and then invoked.

                                                          server.prependOnceListener('connection', (stream) => {
                                                            console.log('Ah, we have our first user!');
                                                          });

                                                          Returns a reference to the EventEmitter, so that calls can be chained.

                                                          -

                                                          Type Parameters

                                                          • K

                                                          Parameters

                                                          • eventName: Key<K, T>

                                                            The name of the event.

                                                            -
                                                          • listener: Listener<K, T>

                                                            The callback function

                                                            -

                                                          Returns this

                                                          v6.0.0

                                                          -

                                                        • Returns a copy of the array of listeners for the event named eventName, +

                                                          Type Parameters

                                                          • K

                                                          Parameters

                                                          • eventName: Key<K, T>

                                                            The name of the event.

                                                            +
                                                          • listener: Listener<K, T>

                                                            The callback function

                                                            +

                                                          Returns this

                                                          v6.0.0

                                                          +

                                                        • Returns a copy of the array of listeners for the event named eventName, including any wrappers (such as those created by .once()).

                                                          import { EventEmitter } from 'node:events';
                                                          const emitter = new EventEmitter();
                                                          emitter.once('log', () => console.log('log once'));

                                                          // Returns a new Array with a function `onceWrapper` which has a property
                                                          // `listener` which contains the original listener bound above
                                                          const listeners = emitter.rawListeners('log');
                                                          const logFnWrapper = listeners[0];

                                                          // Logs "log once" to the console and does not unbind the `once` event
                                                          logFnWrapper.listener();

                                                          // Logs "log once" to the console and removes the listener
                                                          logFnWrapper();

                                                          emitter.on('log', () => console.log('log persistently'));
                                                          // Will return a new Array with a single function bound by `.on()` above
                                                          const newListeners = emitter.rawListeners('log');

                                                          // Logs "log persistently" twice
                                                          newListeners[0]();
                                                          emitter.emit('log');
                                                          -

                                                          Type Parameters

                                                          • K

                                                          Parameters

                                                          Returns Listener<K, T, Function>[]

                                                          v9.4.0

                                                          -

                                                        • Removes all listeners, or those of the specified eventName.

                                                          +

                                                          Type Parameters

                                                          • K

                                                          Parameters

                                                          Returns Listener<K, T, Function>[]

                                                          v9.4.0

                                                          +

                                                        • Removes all listeners, or those of the specified eventName.

                                                          It is bad practice to remove listeners added elsewhere in the code, particularly when the EventEmitter instance was created by some other component or module (e.g. sockets or file streams).

                                                          Returns a reference to the EventEmitter, so that calls can be chained.

                                                          -

                                                          Parameters

                                                          • OptionaleventName: Key<unknown, T>

                                                          Returns this

                                                          v0.1.26

                                                          -

                                                        • Removes the specified listener from the listener array for the event named eventName.

                                                          +

                                                          Parameters

                                                          • OptionaleventName: Key<unknown, T>

                                                          Returns this

                                                          v0.1.26

                                                          +

                                                        • Removes the specified listener from the listener array for the event named eventName.

                                                          const callback = (stream) => {
                                                            console.log('someone connected!');
                                                          };
                                                          server.on('connection', callback);
                                                          // ...
                                                          server.removeListener('connection', callback);
                                                          @@ -188,14 +188,14 @@

                                                          Returns a reference to the EventEmitter, so that calls can be chained.

                                                          -

                                                          Type Parameters

                                                          • K

                                                          Parameters

                                                          Returns this

                                                          v0.1.26

                                                          -

                                                        • By default EventEmitters will print a warning if more than 10 listeners are +

                                                          Type Parameters

                                                          • K

                                                          Parameters

                                                          Returns this

                                                          v0.1.26

                                                          +

                                                        • By default EventEmitters will print a warning if more than 10 listeners are added for a particular event. This is a useful default that helps finding memory leaks. The emitter.setMaxListeners() method allows the limit to be modified for this specific EventEmitter instance. The value can be set to Infinity (or 0) to indicate an unlimited number of listeners.

                                                          Returns a reference to the EventEmitter, so that calls can be chained.

                                                          Parameters

                                                          • n: number

                                                          Returns this

                                                          v0.3.5

                                                          -

                                                        • Listens once to the abort event on the provided signal.

                                                          +

                                                        • Listens once to the abort event on the provided signal.

                                                          Listening to the abort event on abort signals is unsafe and may lead to resource leaks since another third party with the signal can call e.stopImmediatePropagation(). Unfortunately Node.js cannot change @@ -210,7 +210,7 @@

                                                          Parameters

                                                          Returns Disposable

                                                          Disposable that removes the abort listener.

                                                          v20.5.0

                                                          -

                                                        • Returns a copy of the array of listeners for the event named eventName.

                                                          +

                                                        • Returns a copy of the array of listeners for the event named eventName.

                                                          For EventEmitters this behaves exactly the same as calling .listeners on the emitter.

                                                          For EventTargets this is the only way to get the event listeners for the @@ -219,7 +219,7 @@

                                                          Parameters

                                                          Returns Function[]

                                                          v15.2.0, v14.17.0

                                                          -

                                                        • Returns the currently set max amount of listeners.

                                                          For EventEmitters this behaves exactly the same as calling .getMaxListeners on the emitter.

                                                          For EventTargets this is the only way to get the max event listeners for the @@ -229,15 +229,15 @@

                                                          Parameters

                                                          Returns number

                                                          v19.9.0

                                                          -

                                                        • A class method that returns the number of listeners for the given eventName registered on the given emitter.

                                                          +

                                                        • A class method that returns the number of listeners for the given eventName registered on the given emitter.

                                                          import { EventEmitter, listenerCount } from 'node:events';

                                                          const myEmitter = new EventEmitter();
                                                          myEmitter.on('event', () => {});
                                                          myEmitter.on('event', () => {});
                                                          console.log(listenerCount(myEmitter, 'event'));
                                                          // Prints: 2

                                                          Parameters

                                                          • emitter: EventEmitter

                                                            The emitter to query

                                                            -
                                                          • eventName: string | symbol

                                                            The event name

                                                            -

                                                          Returns number

                                                          v0.9.12

                                                          +
                                                        • eventName: string | symbol

                                                          The event name

                                                          +

                                                        Returns number

                                                        v0.9.12

                                                        Since v3.2.0 - Use listenerCount instead.

                                                        -
                                                        • import { on, EventEmitter } from 'node:events';
                                                          import process from 'node:process';

                                                          const ee = new EventEmitter();

                                                          // Emit later on
                                                          process.nextTick(() => {
                                                            ee.emit('foo', 'bar');
                                                            ee.emit('foo', 42);
                                                          });

                                                          for await (const event of on(ee, 'foo')) {
                                                            // The execution of this inner block is synchronous and it
                                                            // processes one event at a time (even with await). Do not use
                                                            // if concurrent execution is required.
                                                            console.log(event); // prints ['bar'] [42]
                                                          }
                                                          // Unreachable here
+
                                                        • import { on, EventEmitter } from 'node:events';
                                                          import process from 'node:process';

                                                          const ee = new EventEmitter();

                                                          // Emit later on
                                                          process.nextTick(() => {
                                                            ee.emit('foo', 'bar');
                                                            ee.emit('foo', 42);
                                                          });

                                                          for await (const event of on(ee, 'foo')) {
                                                            // The execution of this inner block is synchronous and it
                                                            // processes one event at a time (even with await). Do not use
                                                            // if concurrent execution is required.
                                                            console.log(event); // prints ['bar'] [42]
                                                          }
                                                          // Unreachable here

                                                          Returns an AsyncIterator that iterates eventName events. It will throw @@ -254,7 +254,7 @@

                                                          Parameters

                                                          Returns AsyncIterator<any[]>

                                                          An AsyncIterator that iterates eventName events emitted by the emitter

                                                          v13.6.0, v12.16.0

                                                          -
                                                        • import { on, EventEmitter } from 'node:events';
                                                          import process from 'node:process';

                                                          const ee = new EventEmitter();

                                                          // Emit later on
                                                          process.nextTick(() => {
                                                            ee.emit('foo', 'bar');
                                                            ee.emit('foo', 42);
                                                          });

                                                          for await (const event of on(ee, 'foo')) {
                                                            // The execution of this inner block is synchronous and it
                                                            // processes one event at a time (even with await). Do not use
                                                            // if concurrent execution is required.
                                                            console.log(event); // prints ['bar'] [42]
                                                          }
                                                          // Unreachable here
+
                                                        • import { on, EventEmitter } from 'node:events';
                                                          import process from 'node:process';

                                                          const ee = new EventEmitter();

                                                          // Emit later on
                                                          process.nextTick(() => {
                                                            ee.emit('foo', 'bar');
                                                            ee.emit('foo', 42);
                                                          });

                                                          for await (const event of on(ee, 'foo')) {
                                                            // The execution of this inner block is synchronous and it
                                                            // processes one event at a time (even with await). Do not use
                                                            // if concurrent execution is required.
                                                            console.log(event); // prints ['bar'] [42]
                                                          }
                                                          // Unreachable here

                                                          Returns an AsyncIterator that iterates eventName events. It will throw @@ -271,7 +271,7 @@

                                                          Parameters

                                                          Returns AsyncIterator<any[]>

                                                          An AsyncIterator that iterates eventName events emitted by the emitter

                                                          v13.6.0, v12.16.0

                                                          -

                                                        • Creates a Promise that is fulfilled when the EventEmitter emits the given +

                                                        • Creates a Promise that is fulfilled when the EventEmitter emits the given event or that is rejected if the EventEmitter emits 'error' while waiting. The Promise will resolve with an array of all the arguments emitted to the given event.

                                                          @@ -291,7 +291,7 @@

                                                          Parameters

                                                          Returns Promise<any[]>

                                                          v11.13.0, v10.16.0

                                                          -

                                                        • Creates a Promise that is fulfilled when the EventEmitter emits the given +

                                                        • Creates a Promise that is fulfilled when the EventEmitter emits the given event or that is rejected if the EventEmitter emits 'error' while waiting. The Promise will resolve with an array of all the arguments emitted to the given event.

                                                          @@ -311,11 +311,11 @@

                                                          Parameters

                                                          Returns Promise<any[]>

                                                          v11.13.0, v10.16.0

                                                          -
                                                        • import { setMaxListeners, EventEmitter } from 'node:events';

                                                          const target = new EventTarget();
                                                          const emitter = new EventEmitter();

                                                          setMaxListeners(5, target, emitter);
+
                                                        • import { setMaxListeners, EventEmitter } from 'node:events';

                                                          const target = new EventTarget();
                                                          const emitter = new EventEmitter();

                                                          setMaxListeners(5, target, emitter);

                                                          Parameters

                                                          • Optionaln: number

                                                            A non-negative number. The maximum number of listeners per EventTarget event.

                                                            -
                                                          • ...eventTargets: (EventEmitter<DefaultEventMap> | EventTarget)[]

                                                            Zero or more {EventTarget} or {EventEmitter} instances. If none are specified, n is set as the default max for all newly created {EventTarget} and {EventEmitter} +

                                                          • ...eventTargets: (EventEmitter<DefaultEventMap> | EventTarget)[]

                                                            Zero or more {EventTarget} or {EventEmitter} instances. If none are specified, n is set as the default max for all newly created {EventTarget} and {EventEmitter} objects.

                                                            -

                                                          Returns void

                                                          v15.4.0

                                                          -

                                                        Settings

                                                        Member Visibility

                                                        On This Page

                                                        Constructors
                                                        Properties
                                                        Methods
                                                        +

                                                        Returns void

                                                        v15.4.0

                                                        +

                                                        Settings

                                                        Member Visibility

                                                        On This Page

                                                        Constructors
                                                        Properties
                                                        Methods
                                                        diff --git a/docs/classes/_internal_.Headers.html b/docs/classes/_internal_.Headers.html index 44b3fbca..7ed8783c 100644 --- a/docs/classes/_internal_.Headers.html +++ b/docs/classes/_internal_.Headers.html @@ -1,4 +1,4 @@ -Headers | ts-lambda-api - v2.5.2
                                                        ts-lambda-api - v2.5.2
                                                          Preparing search index...

                                                          Class Headers

                                                          Implements

                                                          Index

                                                          Constructors

                                                          constructor +Headers | ts-lambda-api - v2.5.2
                                                          ts-lambda-api - v2.5.2
                                                            Preparing search index...

                                                            Class Headers

                                                            Implements

                                                            Index

                                                            Constructors

                                                            constructor

                                                            Properties

                                                            [iterator] append delete @@ -10,4 +10,4 @@ keys set values -

                                                            Constructors

                                                            Properties

                                                            "[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>

                                                            Settings

                                                            Member Visibility

                                                            On This Page

                                                            Constructors
                                                            Properties
                                                            +

                                                            Constructors

                                                            Properties

                                                            "[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>

                                                            Settings

                                                            Member Visibility

                                                            On This Page

                                                            Constructors
                                                            Properties
                                                            diff --git a/docs/classes/_internal_.HttpRequest.html b/docs/classes/_internal_.HttpRequest.html index eb72bda4..7337a257 100644 --- a/docs/classes/_internal_.HttpRequest.html +++ b/docs/classes/_internal_.HttpRequest.html @@ -1,4 +1,4 @@ -HttpRequest | ts-lambda-api - v2.5.2
                                                            ts-lambda-api - v2.5.2
                                                              Preparing search index...

                                                              Class HttpRequest

                                                              Hierarchy (View Summary)

                                                              Implements

                                                              Index

                                                              Constructors

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

                                                                Class HttpRequest

                                                                Hierarchy (View Summary)

                                                                Implements

                                                                Index

                                                                Constructors

                                                                constructor

                                                                Properties

                                                                body? fragment? headers @@ -13,12 +13,12 @@

                                                                Methods

                                                                clone clone isInstance -

                                                                Constructors

                                                                Properties

                                                                Optionalbody

                                                                body?: any
                                                                fragment?: string
                                                                headers: HeaderBag
                                                                hostname: string
                                                                method: string
                                                                password?: string
                                                                path: string
                                                                port?: number
                                                                protocol: string
                                                                query: QueryParameterBag
                                                                username?: string

                                                                Methods

                                                                • Returns HttpRequest

                                                                  use static HttpRequest.clone(request) instead. It's not safe to call +

                                                                Constructors

                                                                Properties

                                                                Optionalbody

                                                                body?: any
                                                                fragment?: string
                                                                headers: HeaderBag
                                                                hostname: string
                                                                method: string
                                                                password?: string
                                                                path: string
                                                                port?: number
                                                                protocol: string
                                                                query: QueryParameterBag
                                                                username?: string

                                                                Methods

                                                                • Returns HttpRequest

                                                                  use static HttpRequest.clone(request) instead. It's not safe to call this method because HttpRequest.isInstance incorrectly asserts that IHttpRequest (interface) objects are of type HttpRequest (class).

                                                                  -

                                                                • This method only actually asserts that request is the interface IHttpRequest, +

                                                                • This method only actually asserts that request is the interface IHttpRequest, and not necessarily this concrete class. Left in place for API stability.

                                                                  Do not call instance methods on the input of this function, and do not assume it has the HttpRequest prototype.

                                                                  -

                                                                  Parameters

                                                                  • request: unknown

                                                                  Returns request is HttpRequest

                                                                Settings

                                                                Member Visibility

                                                                On This Page

                                                                Constructors
                                                                Properties
                                                                Methods
                                                                +

                                                                Parameters

                                                                • request: unknown

                                                                Returns request is HttpRequest

                                                                Settings

                                                                Member Visibility

                                                                On This Page

                                                                Constructors
                                                                Properties
                                                                Methods
                                                                diff --git a/docs/classes/_internal_.HttpResponse.html b/docs/classes/_internal_.HttpResponse.html index b1aec7d8..47fe645c 100644 --- a/docs/classes/_internal_.HttpResponse.html +++ b/docs/classes/_internal_.HttpResponse.html @@ -1,4 +1,4 @@ -HttpResponse | ts-lambda-api - v2.5.2
                                                                ts-lambda-api - v2.5.2
                                                                  Preparing search index...

                                                                  Class HttpResponse

                                                                  Hierarchy (View Summary)

                                                                  Index

                                                                  Constructors

                                                                  constructor +HttpResponse | ts-lambda-api - v2.5.2
                                                                  ts-lambda-api - v2.5.2
                                                                    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 c3f92f28..cbf88af8 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 @@ -97,11 +97,11 @@ once setMaxListeners toWeb -

                                                                    Constructors

                                                                    Properties

                                                                    aborted: boolean

                                                                    The message.aborted property will be true if the request has +

                                                                    Constructors

                                                                    Properties

                                                                    aborted: boolean

                                                                    The message.aborted property will be true if the request has been aborted.

                                                                    v10.1.0

                                                                    Since v17.0.0,v16.12.0 - Check message.destroyed from stream.Readable.

                                                                    -
                                                                    closed: boolean

                                                                    Is true after 'close' has been emitted.

                                                                    +
                                                                    closed: boolean

                                                                    Is true after 'close' has been emitted.

                                                                    v18.0.0

                                                                    complete: boolean

                                                                    The message.complete property will be true if a complete HTTP message has been received and successfully parsed.

                                                                    @@ -111,10 +111,10 @@

                                                                    v0.3.0

                                                                    -
                                                                    connection: Socket

                                                                    Alias for message.socket.

                                                                    +
                                                                    connection: Socket

                                                                    Alias for message.socket.

                                                                    v0.1.90

                                                                    Since v16.0.0 - Use socket.

                                                                    -
                                                                    destroyed: boolean

                                                                    Is true after readable.destroy() has been called.

                                                                    +
                                                                    destroyed: boolean

                                                                    Is true after readable.destroy() has been called.

                                                                    v8.0.0

                                                                    errored: Error

                                                                    Returns error if the stream has been destroyed with an error.

                                                                    v18.0.0

                                                                    @@ -136,21 +136,21 @@
                                                                  • For all other headers, the values are joined together with , .

                                                                    • v0.1.5

                                                                    -
                                                                    headersDistinct: Dict<string[]>

                                                                    Similar to message.headers, but there is no join logic and the values are +

                                                                    headersDistinct: Dict<string[]>

                                                                    Similar to message.headers, but there is no join logic and the values are always arrays of strings, even for headers received just once.

                                                                    // Prints something like:
                                                                    //
                                                                    // { 'user-agent': ['curl/7.22.0'],
                                                                    //   host: ['127.0.0.1:8000'],
                                                                    //   accept: ['*'] }
                                                                    console.log(request.headersDistinct);

                                                                    v18.3.0, v16.17.0

                                                                    -
                                                                    httpVersion: string

                                                                    In case of server request, the HTTP version sent by the client. In the case of +

                                                                    httpVersion: string

                                                                    In case of server request, the HTTP version sent by the client. In the case of client response, the HTTP version of the connected-to server. Probably either '1.1' or '1.0'.

                                                                    Also message.httpVersionMajor is the first integer and message.httpVersionMinor is the second.

                                                                    v0.1.1

                                                                    -
                                                                    httpVersionMajor: number
                                                                    httpVersionMinor: number
                                                                    method?: string

                                                                    Only valid for request obtained from Server.

                                                                    +
                                                                    httpVersionMajor: number
                                                                    httpVersionMinor: number
                                                                    method?: string

                                                                    Only valid for request obtained from Server.

                                                                    The request method as a string. Read only. Examples: 'GET', 'DELETE'.

                                                                    v0.1.1

                                                                    -
                                                                    rawHeaders: string[]

                                                                    The raw request/response headers list exactly as they were received.

                                                                    +
                                                                    rawHeaders: string[]

                                                                    The raw request/response headers list exactly as they were received.

                                                                    The keys and values are in the same list. It is not a list of tuples. So, the even-numbered offsets are key values, and the odd-numbered offsets are the associated values.

                                                                    @@ -159,10 +159,10 @@

                                                                    v0.11.6

                                                                    -
                                                                    rawTrailers: string[]

                                                                    The raw request/response trailer keys and values exactly as they were +

                                                                    rawTrailers: string[]

                                                                    The raw request/response trailer keys and values exactly as they were received. Only populated at the 'end' event.

                                                                    v0.11.6

                                                                    -
                                                                    readable: boolean

                                                                    Is true if it is safe to call read, which means +

                                                                    readable: boolean

                                                                    Is true if it is safe to call read, which means the stream has not been destroyed or emitted 'error' or 'end'.

                                                                    v11.4.0

                                                                    readableAborted: boolean

                                                                    Returns whether the stream was destroyed or errored before emitting 'end'.

                                                                    @@ -191,19 +191,19 @@ a subclass of stream.Duplex, unless the user specified a socket type other than net.Socket or internally nulled.

                                                                    v0.3.0

                                                                    -
                                                                    statusCode?: number

                                                                    Only valid for response obtained from ClientRequest.

                                                                    +
                                                                    statusCode?: number

                                                                    Only valid for response obtained from ClientRequest.

                                                                    The 3-digit HTTP response status code. E.G. 404.

                                                                    v0.1.1

                                                                    -
                                                                    statusMessage?: string

                                                                    Only valid for response obtained from ClientRequest.

                                                                    +
                                                                    statusMessage?: string

                                                                    Only valid for response obtained from ClientRequest.

                                                                    The HTTP response status message (reason phrase). E.G. OK or Internal Server Error.

                                                                    v0.11.10

                                                                    -
                                                                    trailers: Dict<string>

                                                                    The request/response trailers object. Only populated at the 'end' event.

                                                                    +
                                                                    trailers: Dict<string>

                                                                    The request/response trailers object. Only populated at the 'end' event.

                                                                    v0.3.0

                                                                    -
                                                                    trailersDistinct: Dict<string[]>

                                                                    Similar to message.trailers, but there is no join logic and the values are +

                                                                    trailersDistinct: Dict<string[]>

                                                                    Similar to message.trailers, but there is no join logic and the values are always arrays of strings, even for headers received just once. Only populated at the 'end' event.

                                                                    v18.3.0, v16.17.0

                                                                    -
                                                                    url?: string

                                                                    Only valid for request obtained from Server.

                                                                    +
                                                                    url?: string

                                                                    Only valid for request obtained from Server.

                                                                    Request URL string. This contains only the URL that is present in the actual HTTP request. Take the following request:

                                                                    GET /status?name=ryan HTTP/1.1
@@ -221,13 +221,13 @@
 
                                                                    Ensure that you set process.env.HOST to the server's host name, or consider replacing this part entirely. If using req.headers.host, ensure proper
 validation is used, as clients may specify a custom Host header.

                                                                    v0.1.90

                                                                    -
                                                                    captureRejections: boolean

                                                                    Value: boolean

                                                                    +
                                                                    captureRejections: boolean

                                                                    Value: boolean

                                                                    Change the default captureRejections option on all new EventEmitter objects.

                                                                    v13.4.0, v12.16.0

                                                                    -
                                                                    captureRejectionSymbol: typeof captureRejectionSymbol

                                                                    Value: Symbol.for('nodejs.rejection')

                                                                    +
                                                                    captureRejectionSymbol: typeof captureRejectionSymbol

                                                                    Value: Symbol.for('nodejs.rejection')

                                                                    See how to write a custom rejection handler.

                                                                    v13.4.0, v12.16.0

                                                                    -
                                                                    defaultMaxListeners: number

                                                                    By default, a maximum of 10 listeners can be registered for any single +

                                                                    defaultMaxListeners: number

                                                                    By default, a maximum of 10 listeners can be registered for any single event. This limit can be changed for individual EventEmitter instances using the emitter.setMaxListeners(n) method. To change the default for allEventEmitter instances, the events.defaultMaxListeners property @@ -252,13 +252,16 @@ listeners, respectively. Its name property is set to 'MaxListenersExceededWarning'.

                                                                    v0.11.2

                                                                    -
                                                                    errorMonitor: typeof errorMonitor

                                                                    This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

                                                                    +
                                                                    errorMonitor: typeof errorMonitor

                                                                    This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

                                                                    Installing a listener using this symbol does not change the behavior once an 'error' event is emitted. Therefore, the process will still crash if no regular 'error' listener is installed.

                                                                    v13.6.0, v12.17.0

                                                                    -

                                                                    Methods

                                                                    Optional_construct

                                                                    • _construct(callback: (error?: Error) => void): void

                                                                      Parameters

                                                                      • callback: (error?: Error) => void

                                                                      Returns void

                                                                    _destroy

                                                                    • _destroy(error: Error, callback: (error?: Error) => void): void

                                                                      Parameters

                                                                      • error: Error
                                                                      • callback: (error?: Error) => void

                                                                      Returns void

                                                                    _read

                                                                    • _read(size: number): void

                                                                      Parameters

                                                                      • size: number

                                                                      Returns void

                                                                    • Calls readable.destroy() with an AbortError and returns a promise that fulfills when the stream is finished.

                                                                      +

                                                                    Methods

                                                                    Optional_construct

                                                                    • _construct?(callback: (error?: Error) => void): void

                                                                      Parameters

                                                                      • callback: (error?: Error) => void

                                                                      Returns void

                                                                    _destroy

                                                                    • _destroy(error: Error, callback: (error?: Error) => void): void

                                                                      Parameters

                                                                      • error: Error
                                                                      • callback: (error?: Error) => void

                                                                      Returns void

                                                                    _read

                                                                    • _read(size: number): void

                                                                      Parameters

                                                                      • size: number

                                                                      Returns void

                                                                    • Calls readable.destroy() with an AbortError and returns +a promise that fulfills when the stream is finished.

                                                                      Returns Promise<void>

                                                                      v20.4.0

                                                                      -

                                                                    • Returns AsyncIterator<any>

                                                                    • Type Parameters

                                                                      • K

                                                                      Parameters

                                                                      • error: Error
                                                                      • event: string | symbol
                                                                      • ...args: AnyRest

                                                                      Returns void

                                                                    • Event emitter +

                                                                    • Returns AsyncIterator<any>

                                                                      AsyncIterator to fully consume the stream.

                                                                      +

                                                                      v10.0.0

                                                                      +

                                                                    • Type Parameters

                                                                      • K

                                                                      Parameters

                                                                      • error: Error
                                                                      • event: string | symbol
                                                                      • ...args: AnyRest

                                                                      Returns void

                                                                    • Event emitter The defined events on documents including:

                                                                      1. close
                                                                        2. @@ -269,7 +272,7 @@
                                                                      2. readable
                                                                      3. resume
                                                                      -

                                                                      Parameters

                                                                      • event: "close"
                                                                      • listener: () => void

                                                                      Returns this

                                                                    • Event emitter +

                                                                      Parameters

                                                                      • event: "close"
                                                                      • listener: () => void

                                                                      Returns this

                                                                    • Event emitter The defined events on documents including:

                                                                      1. close
                                                                        2. @@ -280,7 +283,7 @@
                                                                      2. readable
                                                                      3. resume
                                                                      -

                                                                      Parameters

                                                                      • event: "data"
                                                                      • listener: (chunk: any) => void

                                                                      Returns this

                                                                    • Event emitter +

                                                                      Parameters

                                                                      • event: "data"
                                                                      • listener: (chunk: any) => void

                                                                      Returns this

                                                                    • Event emitter The defined events on documents including:

                                                                      1. close
                                                                        2. @@ -291,7 +294,7 @@
                                                                      2. readable
                                                                      3. resume
                                                                      -

                                                                      Parameters

                                                                      • event: "end"
                                                                      • listener: () => void

                                                                      Returns this

                                                                    • Event emitter +

                                                                      Parameters

                                                                      • event: "end"
                                                                      • listener: () => void

                                                                      Returns this

                                                                    • Event emitter The defined events on documents including:

                                                                      1. close
                                                                        2. @@ -302,7 +305,7 @@
                                                                      2. readable
                                                                      3. resume
                                                                      -

                                                                      Parameters

                                                                      • event: "error"
                                                                      • listener: (err: Error) => void

                                                                      Returns this

                                                                    • Event emitter +

                                                                      Parameters

                                                                      • event: "error"
                                                                      • listener: (err: Error) => void

                                                                      Returns this

                                                                    • Event emitter The defined events on documents including:

                                                                      1. close
                                                                        2. @@ -313,7 +316,7 @@
                                                                      2. readable
                                                                      3. resume
                                                                      -

                                                                      Parameters

                                                                      • event: "pause"
                                                                      • listener: () => void

                                                                      Returns this

                                                                    • Event emitter +

                                                                      Parameters

                                                                      • event: "pause"
                                                                      • listener: () => void

                                                                      Returns this

                                                                    • Event emitter The defined events on documents including:

                                                                      1. close
                                                                        2. @@ -324,7 +327,7 @@
                                                                      2. readable
                                                                      3. resume
                                                                      -

                                                                      Parameters

                                                                      • event: "readable"
                                                                      • listener: () => void

                                                                      Returns this

                                                                    • Event emitter +

                                                                      Parameters

                                                                      • event: "readable"
                                                                      • listener: () => void

                                                                      Returns this

                                                                    • Event emitter The defined events on documents including:

                                                                      1. close
                                                                        2. @@ -335,7 +338,7 @@
                                                                      2. readable
                                                                      3. resume
                                                                      -

                                                                      Parameters

                                                                      • event: "resume"
                                                                      • listener: () => void

                                                                      Returns this

                                                                    • Event emitter +

                                                                      Parameters

                                                                      • event: "resume"
                                                                      • listener: () => void

                                                                      Returns this

                                                                    • Event emitter The defined events on documents including:

                                                                      1. close
                                                                        2. @@ -346,67 +349,67 @@
                                                                      2. readable
                                                                      3. resume
                                                                      -

                                                                      Parameters

                                                                      • event: string | symbol
                                                                      • listener: (...args: any[]) => void

                                                                      Returns this

                                                                    • This method returns a new stream with chunks of the underlying stream paired with a counter +

                                                                      Parameters

                                                                      • event: string | symbol
                                                                      • listener: (...args: any[]) => void

                                                                      Returns this

                                                                    • This method returns a new stream with chunks of the underlying stream paired with a counter in the form [index, chunk]. The first index value is 0 and it increases by 1 for each chunk produced.

                                                                      Parameters

                                                                      Returns Readable

                                                                      a stream of indexed pairs.

                                                                      -

                                                                      v17.5.0

                                                                      -

                                                                    • Calls destroy() on the socket that received the IncomingMessage. If error is provided, an 'error' event is emitted on the socket and error is passed +

                                                                      v17.5.0

                                                                      +

                                                                    • Calls destroy() on the socket that received the IncomingMessage. If error is provided, an 'error' event is emitted on the socket and error is passed as an argument to any listeners on the event.

                                                                      -

                                                                      Parameters

                                                                      • Optionalerror: Error

                                                                      Returns this

                                                                      v0.3.0

                                                                      -

                                                                    • This method returns a new stream with the first limit chunks dropped from the start.

                                                                      +

                                                                      Parameters

                                                                      • Optionalerror: Error

                                                                      Returns this

                                                                      v0.3.0

                                                                      +

                                                                    • This method returns a new stream with the first limit chunks dropped from the start.

                                                                      Parameters

                                                                      • limit: number

                                                                        the number of chunks to drop from the readable.

                                                                        -
                                                                      • Optionaloptions: Pick<Stream.ArrayOptions, "signal">

                                                                      Returns Readable

                                                                      a stream with limit chunks dropped from the start.

                                                                      -

                                                                      v17.5.0

                                                                      +
                                                                    • Optionaloptions: Pick<Stream.ArrayOptions, "signal">

                                                                    Returns Readable

                                                                    a stream with limit chunks dropped from the start.

                                                                    +

                                                                    v17.5.0

                                                                    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

                                                                      Returns true if the event had listeners, false otherwise.

                                                                      import { EventEmitter } from 'node:events';
                                                                      const myEmitter = new EventEmitter();

                                                                      // First listener
                                                                      myEmitter.on('event', function firstListener() {
                                                                        console.log('Helloooo! first listener');
                                                                      });
                                                                      // Second listener
                                                                      myEmitter.on('event', function secondListener(arg1, arg2) {
                                                                        console.log(`event with parameters ${arg1}, ${arg2} in second listener`);
                                                                      });
                                                                      // Third listener
                                                                      myEmitter.on('event', function thirdListener(...args) {
                                                                        const parameters = args.join(', ');
                                                                        console.log(`event with parameters ${parameters} in third listener`);
                                                                      });

                                                                      console.log(myEmitter.listeners('event'));

                                                                      myEmitter.emit('event', 1, 2, 3, 4, 5);

                                                                      // Prints:
                                                                      // [
                                                                      //   [Function: firstListener],
                                                                      //   [Function: secondListener],
                                                                      //   [Function: thirdListener]
                                                                      // ]
                                                                      // Helloooo! first listener
                                                                      // event with parameters 1, 2 in second listener
                                                                      // event with parameters 1, 2, 3, 4, 5 in third listener
                                                                      -

                                                                      Parameters

                                                                      • event: "close"

                                                                      Returns boolean

                                                                      v0.1.26

                                                                      -

                                                                    • Parameters

                                                                      • event: "data"
                                                                      • chunk: any

                                                                      Returns boolean

                                                                    • Parameters

                                                                      • event: "end"

                                                                      Returns boolean

                                                                    • Parameters

                                                                      • event: "error"
                                                                      • err: Error

                                                                      Returns boolean

                                                                    • Parameters

                                                                      • event: "pause"

                                                                      Returns boolean

                                                                    • Parameters

                                                                      • event: "readable"

                                                                      Returns boolean

                                                                    • Parameters

                                                                      • event: "resume"

                                                                      Returns boolean

                                                                    • Parameters

                                                                      • event: string | symbol
                                                                      • ...args: any[]

                                                                      Returns boolean

                                                                    • Returns an array listing the events for which the emitter has registered +

                                                                      Parameters

                                                                      • event: "close"

                                                                      Returns boolean

                                                                      v0.1.26

                                                                      +

                                                                    • Parameters

                                                                      • event: "data"
                                                                      • chunk: any

                                                                      Returns boolean

                                                                    • Parameters

                                                                      • event: "end"

                                                                      Returns boolean

                                                                    • Parameters

                                                                      • event: "error"
                                                                      • err: Error

                                                                      Returns boolean

                                                                    • Parameters

                                                                      • event: "pause"

                                                                      Returns boolean

                                                                    • Parameters

                                                                      • event: "readable"

                                                                      Returns boolean

                                                                    • Parameters

                                                                      • event: "resume"

                                                                      Returns boolean

                                                                    • Parameters

                                                                      • event: string | symbol
                                                                      • ...args: any[]

                                                                      Returns boolean

                                                                    • Returns an array listing the events for which the emitter has registered listeners. The values in the array are strings or Symbols.

                                                                      import { EventEmitter } from 'node:events';

                                                                      const myEE = new EventEmitter();
                                                                      myEE.on('foo', () => {});
                                                                      myEE.on('bar', () => {});

                                                                      const sym = Symbol('symbol');
                                                                      myEE.on(sym, () => {});

                                                                      console.log(myEE.eventNames());
                                                                      // Prints: [ 'foo', 'bar', Symbol(symbol) ]
                                                                      -

                                                                      Returns (string | symbol)[]

                                                                      v6.0.0

                                                                      -

                                                                    • This method is similar to Array.prototype.every and calls fn on each chunk in the stream +

                                                                      Returns (string | symbol)[]

                                                                      v6.0.0

                                                                      +

                                                                    • This method is similar to Array.prototype.every and calls fn on each chunk in the stream to check if all awaited return values are truthy value for fn. Once an fn call on a chunk awaited return value is falsy, the stream is destroyed and the promise is fulfilled with false. If all of the fn calls on the chunks return a truthy value, the promise is fulfilled with true.

                                                                      Parameters

                                                                      • fn: (
                                                                            data: any,
                                                                            options?: Pick<Stream.ArrayOptions, "signal">,
                                                                        ) => boolean | Promise<boolean>

                                                                        a function to call on each chunk of the stream. Async or not.

                                                                        -
                                                                      • Optionaloptions: Stream.ArrayOptions

                                                                      Returns Promise<boolean>

                                                                      a promise evaluating to true if fn returned a truthy value for every one of the chunks.

                                                                      -

                                                                      v17.5.0

                                                                      -

                                                                    • This method allows filtering the stream. For each chunk in the stream the fn function will be called +

                                                                    • Optionaloptions: Stream.ArrayOptions

                                                                    Returns Promise<boolean>

                                                                    a promise evaluating to true if fn returned a truthy value for every one of the chunks.

                                                                    +

                                                                    v17.5.0

                                                                    +

                                                                    • This method allows filtering the stream. For each chunk in the stream the fn function will be called and if it returns a truthy value, the chunk will be passed to the result stream. If the fn function returns a promise - that promise will be awaited.

                                                                      Parameters

                                                                      • fn: (
                                                                            data: any,
                                                                            options?: Pick<Stream.ArrayOptions, "signal">,
                                                                        ) => boolean | Promise<boolean>

                                                                        a function to filter chunks from the stream. Async or not.

                                                                        -
                                                                      • Optionaloptions: Stream.ArrayOptions

                                                                      Returns Readable

                                                                      a stream filtered with the predicate fn.

                                                                      -

                                                                      v17.4.0, v16.14.0

                                                                      -

                                                                    • This method is similar to Array.prototype.find and calls fn on each chunk in the stream +

                                                                    • Optionaloptions: Stream.ArrayOptions

                                                                    Returns Readable

                                                                    a stream filtered with the predicate fn.

                                                                    +

                                                                    v17.4.0, v16.14.0

                                                                    +

                                                                    • This method is similar to Array.prototype.find and calls fn on each chunk in the stream to find a chunk with a truthy value for fn. Once an fn call's awaited return value is truthy, the stream is destroyed and the promise is fulfilled with value for which fn returned a truthy value. If all of the fn calls on the chunks return a falsy value, the promise is fulfilled with undefined.

                                                                      Type Parameters

                                                                      • T

                                                                      Parameters

                                                                      Returns Promise<T>

                                                                      a promise evaluating to the first chunk for which fn evaluated with a truthy value, +

                                                                    • Optionaloptions: Stream.ArrayOptions

                                                                    Returns Promise<T>

                                                                    a promise evaluating to the first chunk for which fn evaluated with a truthy value, or undefined if no element was found.

                                                                    -

                                                                    v17.5.0

                                                                    -

                                                                  • This method is similar to Array.prototype.find and calls fn on each chunk in the stream +

                                                                    v17.5.0

                                                                    +

                                                                  • This method is similar to Array.prototype.find and calls fn on each chunk in the stream to find a chunk with a truthy value for fn. Once an fn call's awaited return value is truthy, the stream is destroyed and the promise is fulfilled with value for which fn returned a truthy value. If all of the fn calls on the chunks return a falsy value, the promise is fulfilled with undefined.

                                                                    Parameters

                                                                    • fn: (
                                                                          data: any,
                                                                          options?: Pick<Stream.ArrayOptions, "signal">,
                                                                      ) => boolean | Promise<boolean>

                                                                      a function to call on each chunk of the stream. Async or not.

                                                                      -
                                                                    • Optionaloptions: Stream.ArrayOptions

                                                                    Returns Promise<any>

                                                                    a promise evaluating to the first chunk for which fn evaluated with a truthy value, +

                                                                  • Optionaloptions: Stream.ArrayOptions

                                                                    • Returns Promise<any>

                                                                    a promise evaluating to the first chunk for which fn evaluated with a truthy value, or undefined if no element was found.

                                                                    -

                                                                    v17.5.0

                                                                    -

                                                                    • This method returns a new stream by applying the given callback to each chunk of the stream +

                                                                      v17.5.0

                                                                      +

                                                                    • This method returns a new stream by applying the given callback to each chunk of the stream and then flattening the result.

                                                                      It is possible to return a stream or another iterable or async iterable from fn and the result streams will be merged (flattened) into the returned stream.

                                                                      Parameters

                                                                      • fn: (data: any, options?: Pick<Stream.ArrayOptions, "signal">) => any

                                                                        a function to map over every chunk in the stream. May be async. May be a stream or generator.

                                                                        -
                                                                      • Optionaloptions: Stream.ArrayOptions

                                                                      Returns Readable

                                                                      a stream flat-mapped with the function fn.

                                                                      -

                                                                      v17.5.0

                                                                      -

                                                                    • This method allows iterating a stream. For each chunk in the stream the fn function will be called. +

                                                                    • Optionaloptions: Stream.ArrayOptions

                                                                    Returns Readable

                                                                    a stream flat-mapped with the function fn.

                                                                    +

                                                                    v17.5.0

                                                                    +

                                                                    • This method allows iterating a stream. For each chunk in the stream the fn function will be called. If the fn function returns a promise - that promise will be awaited.

                                                                      This method is different from for await...of loops in that it can optionally process chunks concurrently. In addition, a forEach iteration can only be stopped by having passed a signal option @@ -415,44 +418,44 @@

                                                                      This method is different from listening to the 'data' event in that it uses the readable event in the underlying machinary and can limit the number of concurrent fn calls.

                                                                      Parameters

                                                                      • fn: (
                                                                            data: any,
                                                                            options?: Pick<Stream.ArrayOptions, "signal">,
                                                                        ) => void | Promise<void>

                                                                        a function to call on each chunk of the stream. Async or not.

                                                                        -
                                                                      • Optionaloptions: Stream.ArrayOptions

                                                                      Returns Promise<void>

                                                                      a promise for when the stream has finished.

                                                                      -

                                                                      v17.5.0

                                                                      -

                                                                    • Returns the current max listener value for the EventEmitter which is either +

                                                                    • Optionaloptions: Stream.ArrayOptions

                                                                    Returns Promise<void>

                                                                    a promise for when the stream has finished.

                                                                    +

                                                                    v17.5.0

                                                                    +

                                                                    • Returns the current max listener value for the EventEmitter which is either set by emitter.setMaxListeners(n) or defaults to EventEmitter.defaultMaxListeners.

                                                                      -

                                                                      Returns number

                                                                      v1.0.0

                                                                      -

                                                                    • The readable.isPaused() method returns the current operating state of the Readable. +

                                                                      Returns number

                                                                      v1.0.0

                                                                      +

                                                                    • The readable.isPaused() method returns the current operating state of the Readable. This is used primarily by the mechanism that underlies the readable.pipe() method. In most typical cases, there will be no reason to use this method directly.

                                                                      const readable = new stream.Readable();

                                                                      readable.isPaused(); // === false
                                                                      readable.pause();
                                                                      readable.isPaused(); // === true
                                                                      readable.resume();
                                                                      readable.isPaused(); // === false
                                                                      -

                                                                      Returns boolean

                                                                      v0.11.14

                                                                      +

                                                                      Returns boolean

                                                                      v0.11.14

                                                                    • The iterator created by this method gives users the option to cancel the destruction of the stream if the for await...of loop is exited by return, break, or throw, or if the iterator should destroy the stream if the stream emitted an error during iteration.

                                                                      Parameters

                                                                      • Optionaloptions: { destroyOnReturn?: boolean }
                                                                        • OptionaldestroyOnReturn?: boolean

                                                                          When set to false, calling return on the async iterator, or exiting a for await...of iteration using a break, return, or throw will not destroy the stream. Default: true.

                                                                          -

                                                                      Returns AsyncIterator<any>

                                                                      v16.3.0

                                                                      -

                                                                    • Returns the number of listeners listening for the event named eventName. +

                                                                    Returns AsyncIterator<any>

                                                                    v16.3.0

                                                                    +

                                                                    • Returns the number of listeners listening for the event named eventName. If listener is provided, it will return how many times the listener is found in the list of the listeners of the event.

                                                                      Type Parameters

                                                                      • K

                                                                      Parameters

                                                                      • eventName: string | symbol

                                                                        The name of the event being listened for

                                                                        -
                                                                      • Optionallistener: Function

                                                                        The event handler function

                                                                        -

                                                                      Returns number

                                                                      v3.2.0

                                                                      -

                                                                    • Returns a copy of the array of listeners for the event named eventName.

                                                                      +
                                                                    • Optionallistener: Function

                                                                      The event handler function

                                                                      +

                                                                    Returns number

                                                                    v3.2.0

                                                                    +

                                                                    • Returns a copy of the array of listeners for the event named eventName.

                                                                      server.on('connection', (stream) => {
                                                                        console.log('someone connected!');
                                                                      });
                                                                      console.log(util.inspect(server.listeners('connection')));
                                                                      // Prints: [ [Function] ]
                                                                      -

                                                                      Type Parameters

                                                                      • K

                                                                      Parameters

                                                                      • eventName: string | symbol

                                                                      Returns Function[]

                                                                      v0.1.26

                                                                      -

                                                                    • This method allows mapping over the stream. The fn function will be called for every chunk in the stream. +

                                                                      Type Parameters

                                                                      • K

                                                                      Parameters

                                                                      • eventName: string | symbol

                                                                      Returns Function[]

                                                                      v0.1.26

                                                                      +

                                                                    • This method allows mapping over the stream. The fn function will be called for every chunk in the stream. If the fn function returns a promise - that promise will be awaited before being passed to the result stream.

                                                                      Parameters

                                                                      Returns Readable

                                                                      a stream mapped with the function fn.

                                                                      -

                                                                      v17.4.0, v16.14.0

                                                                      -

                                                                    • Alias for emitter.removeListener().

                                                                      -

                                                                      Type Parameters

                                                                      • K

                                                                      Parameters

                                                                      • eventName: string | symbol
                                                                      • listener: (...args: any[]) => void

                                                                      Returns this

                                                                      v10.0.0

                                                                      -

                                                                    • Adds the listener function to the end of the listeners array for the event +

                                                                    • Optionaloptions: Stream.ArrayOptions

                                                                    Returns Readable

                                                                    a stream mapped with the function fn.

                                                                    +

                                                                    v17.4.0, v16.14.0

                                                                    +

                                                                    • Alias for emitter.removeListener().

                                                                      +

                                                                      Type Parameters

                                                                      • K

                                                                      Parameters

                                                                      • eventName: string | symbol
                                                                      • listener: (...args: any[]) => void

                                                                      Returns this

                                                                      v10.0.0

                                                                      +

                                                                    • Adds the listener function to the end of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.

                                                                      @@ -466,8 +469,8 @@

                                                                      Parameters

                                                                      • event: "close"
                                                                      • listener: () => void

                                                                        The callback function

                                                                        -

                                                                      Returns this

                                                                      v0.1.101

                                                                      -

                                                                    • Parameters

                                                                      • event: "data"
                                                                      • listener: (chunk: any) => void

                                                                      Returns this

                                                                    • Parameters

                                                                      • event: "end"
                                                                      • listener: () => void

                                                                      Returns this

                                                                    • Parameters

                                                                      • event: "error"
                                                                      • listener: (err: Error) => void

                                                                      Returns this

                                                                    • Parameters

                                                                      • event: "pause"
                                                                      • listener: () => void

                                                                      Returns this

                                                                    • Parameters

                                                                      • event: "readable"
                                                                      • listener: () => void

                                                                      Returns this

                                                                    • Parameters

                                                                      • event: "resume"
                                                                      • listener: () => void

                                                                      Returns this

                                                                    • Parameters

                                                                      • event: string | symbol
                                                                      • listener: (...args: any[]) => void

                                                                      Returns this

                                                                    • Adds a one-time listener function for the event named eventName. The +

                                                                    Returns this

                                                                    v0.1.101

                                                                    +

                                                                  • Parameters

                                                                    • event: "data"
                                                                    • listener: (chunk: any) => void

                                                                    Returns this

                                                                  • Parameters

                                                                    • event: "end"
                                                                    • listener: () => void

                                                                    Returns this

                                                                  • Parameters

                                                                    • event: "error"
                                                                    • listener: (err: Error) => void

                                                                    Returns this

                                                                  • Parameters

                                                                    • event: "pause"
                                                                    • listener: () => void

                                                                    Returns this

                                                                  • Parameters

                                                                    • event: "readable"
                                                                    • listener: () => void

                                                                    Returns this

                                                                  • Parameters

                                                                    • event: "resume"
                                                                    • listener: () => void

                                                                    Returns this

                                                                  • Parameters

                                                                    • event: string | symbol
                                                                    • listener: (...args: any[]) => void

                                                                    Returns this

                                                                    • Adds a one-time listener function for the event named eventName. The next time eventName is triggered, this listener is removed and then invoked.

                                                                      server.once('connection', (stream) => {
                                                                        console.log('Ah, we have our first user!');
                                                                      });
                                                                      @@ -479,16 +482,16 @@

                                                                      Parameters

                                                                      • event: "close"
                                                                      • listener: () => void

                                                                        The callback function

                                                                        -

                                                                      Returns this

                                                                      v0.3.0

                                                                      -

                                                                    • Parameters

                                                                      • event: "data"
                                                                      • listener: (chunk: any) => void

                                                                      Returns this

                                                                    • Parameters

                                                                      • event: "end"
                                                                      • listener: () => void

                                                                      Returns this

                                                                    • Parameters

                                                                      • event: "error"
                                                                      • listener: (err: Error) => void

                                                                      Returns this

                                                                    • Parameters

                                                                      • event: "pause"
                                                                      • listener: () => void

                                                                      Returns this

                                                                    • Parameters

                                                                      • event: "readable"
                                                                      • listener: () => void

                                                                      Returns this

                                                                    • Parameters

                                                                      • event: "resume"
                                                                      • listener: () => void

                                                                      Returns this

                                                                    • Parameters

                                                                      • event: string | symbol
                                                                      • listener: (...args: any[]) => void

                                                                      Returns this

                                                                    • The readable.pause() method will cause a stream in flowing mode to stop +

                                                                    Returns this

                                                                    v0.3.0

                                                                    +

                                                                  • Parameters

                                                                    • event: "data"
                                                                    • listener: (chunk: any) => void

                                                                    Returns this

                                                                  • Parameters

                                                                    • event: "end"
                                                                    • listener: () => void

                                                                    Returns this

                                                                  • Parameters

                                                                    • event: "error"
                                                                    • listener: (err: Error) => void

                                                                    Returns this

                                                                  • Parameters

                                                                    • event: "pause"
                                                                    • listener: () => void

                                                                    Returns this

                                                                  • Parameters

                                                                    • event: "readable"
                                                                    • listener: () => void

                                                                    Returns this

                                                                  • Parameters

                                                                    • event: "resume"
                                                                    • listener: () => void

                                                                    Returns this

                                                                  • Parameters

                                                                    • event: string | symbol
                                                                    • listener: (...args: any[]) => void

                                                                    Returns this

                                                                    • The readable.pause() method will cause a stream in flowing mode to stop emitting 'data' events, switching out of flowing mode. Any data that becomes available will remain in the internal buffer.

                                                                      const readable = getReadableStreamSomehow();
                                                                      readable.on('data', (chunk) => {
                                                                        console.log(`Received ${chunk.length} bytes of data.`);
                                                                        readable.pause();
                                                                        console.log('There will be no additional data for 1 second.');
                                                                        setTimeout(() => {
                                                                          console.log('Now data will start flowing again.');
                                                                          readable.resume();
                                                                        }, 1000);
                                                                      });

                                                                      The readable.pause() method has no effect if there is a 'readable' event listener.

                                                                      -

                                                                      Returns this

                                                                      v0.9.4

                                                                      -

                                                                    • Type Parameters

                                                                      Parameters

                                                                      • destination: T
                                                                      • Optionaloptions: { end?: boolean }

                                                                      Returns T

                                                                    • Adds the listener function to the beginning of the listeners array for the +

                                                                      Returns this

                                                                      v0.9.4

                                                                      +

                                                                    • Type Parameters

                                                                      Parameters

                                                                      • destination: T
                                                                      • Optionaloptions: { end?: boolean }

                                                                      Returns T

                                                                    • Adds the listener function to the beginning of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.

                                                                      @@ -497,22 +500,22 @@

                                                                      Returns a reference to the EventEmitter, so that calls can be chained.

                                                                      Parameters

                                                                      • event: "close"
                                                                      • listener: () => void

                                                                        The callback function

                                                                        -

                                                                      Returns this

                                                                      v6.0.0

                                                                      -

                                                                    • Parameters

                                                                      • event: "data"
                                                                      • listener: (chunk: any) => void

                                                                      Returns this

                                                                    • Parameters

                                                                      • event: "end"
                                                                      • listener: () => void

                                                                      Returns this

                                                                    • Parameters

                                                                      • event: "error"
                                                                      • listener: (err: Error) => void

                                                                      Returns this

                                                                    • Parameters

                                                                      • event: "pause"
                                                                      • listener: () => void

                                                                      Returns this

                                                                    • Parameters

                                                                      • event: "readable"
                                                                      • listener: () => void

                                                                      Returns this

                                                                    • Parameters

                                                                      • event: "resume"
                                                                      • listener: () => void

                                                                      Returns this

                                                                    • Parameters

                                                                      • event: string | symbol
                                                                      • listener: (...args: any[]) => void

                                                                      Returns this

                                                                    • Adds a one-timelistener function for the event named eventName to the beginning of the listeners array. The next time eventName is triggered, this +

                                                                    Returns this

                                                                    v6.0.0

                                                                    +

                                                                  • Parameters

                                                                    • event: "data"
                                                                    • listener: (chunk: any) => void

                                                                    Returns this

                                                                  • Parameters

                                                                    • event: "end"
                                                                    • listener: () => void

                                                                    Returns this

                                                                  • Parameters

                                                                    • event: "error"
                                                                    • listener: (err: Error) => void

                                                                    Returns this

                                                                  • Parameters

                                                                    • event: "pause"
                                                                    • listener: () => void

                                                                    Returns this

                                                                  • Parameters

                                                                    • event: "readable"
                                                                    • listener: () => void

                                                                    Returns this

                                                                  • Parameters

                                                                    • event: "resume"
                                                                    • listener: () => void

                                                                    Returns this

                                                                  • Parameters

                                                                    • event: string | symbol
                                                                    • listener: (...args: any[]) => void

                                                                    Returns this

                                                                    • Adds a one-timelistener function for the event named eventName to the beginning of the listeners array. The next time eventName is triggered, this listener is removed, and then invoked.

                                                                      server.prependOnceListener('connection', (stream) => {
                                                                        console.log('Ah, we have our first user!');
                                                                      });

                                                                      Returns a reference to the EventEmitter, so that calls can be chained.

                                                                      Parameters

                                                                      • event: "close"
                                                                      • listener: () => void

                                                                        The callback function

                                                                        -

                                                                      Returns this

                                                                      v6.0.0

                                                                      -

                                                                    • Parameters

                                                                      • event: "data"
                                                                      • listener: (chunk: any) => void

                                                                      Returns this

                                                                    • Parameters

                                                                      • event: "end"
                                                                      • listener: () => void

                                                                      Returns this

                                                                    • Parameters

                                                                      • event: "error"
                                                                      • listener: (err: Error) => void

                                                                      Returns this

                                                                    • Parameters

                                                                      • event: "pause"
                                                                      • listener: () => void

                                                                      Returns this

                                                                    • Parameters

                                                                      • event: "readable"
                                                                      • listener: () => void

                                                                      Returns this

                                                                    • Parameters

                                                                      • event: "resume"
                                                                      • listener: () => void

                                                                      Returns this

                                                                    • Parameters

                                                                      • event: string | symbol
                                                                      • listener: (...args: any[]) => void

                                                                      Returns this

                                                                    • Returns a copy of the array of listeners for the event named eventName, +

                                                                    Returns this

                                                                    v6.0.0

                                                                    +

                                                                  • Parameters

                                                                    • event: "data"
                                                                    • listener: (chunk: any) => void

                                                                    Returns this

                                                                  • Parameters

                                                                    • event: "end"
                                                                    • listener: () => void

                                                                    Returns this

                                                                  • Parameters

                                                                    • event: "error"
                                                                    • listener: (err: Error) => void

                                                                    Returns this

                                                                  • Parameters

                                                                    • event: "pause"
                                                                    • listener: () => void

                                                                    Returns this

                                                                  • Parameters

                                                                    • event: "readable"
                                                                    • listener: () => void

                                                                    Returns this

                                                                  • Parameters

                                                                    • event: "resume"
                                                                    • listener: () => void

                                                                    Returns this

                                                                  • Parameters

                                                                    • event: string | symbol
                                                                    • listener: (...args: any[]) => void

                                                                    Returns this

                                                                    • Returns a copy of the array of listeners for the event named eventName, including any wrappers (such as those created by .once()).

                                                                      import { EventEmitter } from 'node:events';
                                                                      const emitter = new EventEmitter();
                                                                      emitter.once('log', () => console.log('log once'));

                                                                      // Returns a new Array with a function `onceWrapper` which has a property
                                                                      // `listener` which contains the original listener bound above
                                                                      const listeners = emitter.rawListeners('log');
                                                                      const logFnWrapper = listeners[0];

                                                                      // Logs "log once" to the console and does not unbind the `once` event
                                                                      logFnWrapper.listener();

                                                                      // Logs "log once" to the console and removes the listener
                                                                      logFnWrapper();

                                                                      emitter.on('log', () => console.log('log persistently'));
                                                                      // Will return a new Array with a single function bound by `.on()` above
                                                                      const newListeners = emitter.rawListeners('log');

                                                                      // Logs "log persistently" twice
                                                                      newListeners[0]();
                                                                      emitter.emit('log');
                                                                      -

                                                                      Type Parameters

                                                                      • K

                                                                      Parameters

                                                                      • eventName: string | symbol

                                                                      Returns Function[]

                                                                      v9.4.0

                                                                      -

                                                                    • The readable.read() method reads data out of the internal buffer and +

                                                                      Type Parameters

                                                                      • K

                                                                      Parameters

                                                                      • eventName: string | symbol

                                                                      Returns Function[]

                                                                      v9.4.0

                                                                      +

                                                                    • The readable.read() method reads data out of the internal buffer and returns it. If no data is available to be read, null is returned. By default, the data is returned as a Buffer object unless an encoding has been specified using the readable.setEncoding() method or the stream is operating @@ -549,7 +552,7 @@

                                                                      Calling read after the 'end' event has been emitted will return null. No runtime error will be raised.

                                                                      Parameters

                                                                      • Optionalsize: number

                                                                        Optional argument to specify how much data to read.

                                                                        -

                                                                      Returns any

                                                                      v0.9.4

                                                                      +

                                                                    Returns any

                                                                    v0.9.4

                                                                    • This method calls fn on each chunk of the stream in order, passing it the result from the calculation on the previous element. It returns a promise for the final value of the reduction.

                                                                      If no initial value is supplied the first chunk of the stream is used as the initial value. @@ -557,26 +560,26 @@

                                                                      The reducer function iterates the stream element-by-element which means that there is no concurrency parameter or parallelism. To perform a reduce concurrently, you can extract the async function to readable.map method.

                                                                      Type Parameters

                                                                      • T = any

                                                                      Parameters

                                                                      • fn: (previous: any, data: any, options?: Pick<Stream.ArrayOptions, "signal">) => T

                                                                        a reducer function to call over every chunk in the stream. Async or not.

                                                                        -
                                                                      • Optionalinitial: undefined

                                                                        the initial value to use in the reduction.

                                                                        -
                                                                      • Optionaloptions: Pick<Stream.ArrayOptions, "signal">

                                                                      Returns Promise<T>

                                                                      a promise for the final value of the reduction.

                                                                      -

                                                                      v17.5.0

                                                                      -

                                                                    • This method calls fn on each chunk of the stream in order, passing it the result from the calculation +

                                                                    • Optionalinitial: undefined

                                                                      the initial value to use in the reduction.

                                                                      +
                                                                    • Optionaloptions: Pick<Stream.ArrayOptions, "signal">

                                                                    Returns Promise<T>

                                                                    a promise for the final value of the reduction.

                                                                    +

                                                                    v17.5.0

                                                                    +

                                                                  • This method calls fn on each chunk of the stream in order, passing it the result from the calculation on the previous element. It returns a promise for the final value of the reduction.

                                                                    If no initial value is supplied the first chunk of the stream is used as the initial value. If the stream is empty, the promise is rejected with a TypeError with the ERR_INVALID_ARGS code property.

                                                                    The reducer function iterates the stream element-by-element which means that there is no concurrency parameter or parallelism. To perform a reduce concurrently, you can extract the async function to readable.map method.

                                                                    Type Parameters

                                                                    • T = any

                                                                    Parameters

                                                                    • fn: (previous: T, data: any, options?: Pick<Stream.ArrayOptions, "signal">) => T

                                                                      a reducer function to call over every chunk in the stream. Async or not.

                                                                      -
                                                                    • initial: T

                                                                      the initial value to use in the reduction.

                                                                      -
                                                                    • Optionaloptions: Pick<Stream.ArrayOptions, "signal">

                                                                    Returns Promise<T>

                                                                    a promise for the final value of the reduction.

                                                                    -

                                                                    v17.5.0

                                                                    -

                                                                    • Removes all listeners, or those of the specified eventName.

                                                                      +
                                                                    • initial: T

                                                                      the initial value to use in the reduction.

                                                                      +
                                                                    • Optionaloptions: Pick<Stream.ArrayOptions, "signal">

                                                                    Returns Promise<T>

                                                                    a promise for the final value of the reduction.

                                                                    +

                                                                    v17.5.0

                                                                    +

                                                                    • Removes all listeners, or those of the specified eventName.

                                                                      It is bad practice to remove listeners added elsewhere in the code, particularly when the EventEmitter instance was created by some other component or module (e.g. sockets or file streams).

                                                                      Returns a reference to the EventEmitter, so that calls can be chained.

                                                                      -

                                                                      Parameters

                                                                      • OptionaleventName: string | symbol

                                                                      Returns this

                                                                      v0.1.26

                                                                      -

                                                                    • Removes the specified listener from the listener array for the event named eventName.

                                                                      +

                                                                      Parameters

                                                                      • OptionaleventName: string | symbol

                                                                      Returns this

                                                                      v0.1.26

                                                                      +

                                                                    • Removes the specified listener from the listener array for the event named eventName.

                                                                      const callback = (stream) => {
                                                                        console.log('someone connected!');
                                                                      };
                                                                      server.on('connection', callback);
                                                                      // ...
                                                                      server.removeListener('connection', callback);
                                                                      @@ -602,8 +605,8 @@

                                                                      Returns a reference to the EventEmitter, so that calls can be chained.

                                                                      -

                                                                      Parameters

                                                                      • event: "close"
                                                                      • listener: () => void

                                                                      Returns this

                                                                      v0.1.26

                                                                      -

                                                                    • Parameters

                                                                      • event: "data"
                                                                      • listener: (chunk: any) => void

                                                                      Returns this

                                                                    • Parameters

                                                                      • event: "end"
                                                                      • listener: () => void

                                                                      Returns this

                                                                    • Parameters

                                                                      • event: "error"
                                                                      • listener: (err: Error) => void

                                                                      Returns this

                                                                    • Parameters

                                                                      • event: "pause"
                                                                      • listener: () => void

                                                                      Returns this

                                                                    • Parameters

                                                                      • event: "readable"
                                                                      • listener: () => void

                                                                      Returns this

                                                                    • Parameters

                                                                      • event: "resume"
                                                                      • listener: () => void

                                                                      Returns this

                                                                    • Parameters

                                                                      • event: string | symbol
                                                                      • listener: (...args: any[]) => void

                                                                      Returns this

                                                                    • The readable.resume() method causes an explicitly paused Readable stream to +

                                                                      Parameters

                                                                      • event: "close"
                                                                      • listener: () => void

                                                                      Returns this

                                                                      v0.1.26

                                                                      +

                                                                    • Parameters

                                                                      • event: "data"
                                                                      • listener: (chunk: any) => void

                                                                      Returns this

                                                                    • Parameters

                                                                      • event: "end"
                                                                      • listener: () => void

                                                                      Returns this

                                                                    • Parameters

                                                                      • event: "error"
                                                                      • listener: (err: Error) => void

                                                                      Returns this

                                                                    • Parameters

                                                                      • event: "pause"
                                                                      • listener: () => void

                                                                      Returns this

                                                                    • Parameters

                                                                      • event: "readable"
                                                                      • listener: () => void

                                                                      Returns this

                                                                    • Parameters

                                                                      • event: "resume"
                                                                      • listener: () => void

                                                                      Returns this

                                                                    • Parameters

                                                                      • event: string | symbol
                                                                      • listener: (...args: any[]) => void

                                                                      Returns this

                                                                    • The readable.resume() method causes an explicitly paused Readable stream to resume emitting 'data' events, switching the stream into flowing mode.

                                                                      The readable.resume() method can be used to fully consume the data from a stream without actually processing any of that data:

                                                                      @@ -611,8 +614,8 @@

                                                                      The readable.resume() method has no effect if there is a 'readable' event listener.

                                                                      -

                                                                      Returns this

                                                                      v0.9.4

                                                                      -

                                                                    • The readable.setEncoding() method sets the character encoding for +

                                                                      Returns this

                                                                      v0.9.4

                                                                      +

                                                                    • The readable.setEncoding() method sets the character encoding for data read from the Readable stream.

                                                                      By default, no encoding is assigned and stream data will be returned as Buffer objects. Setting an encoding causes the stream data to be returned as strings of the specified encoding rather than as Buffer objects. For instance, calling readable.setEncoding('utf8') will cause the @@ -625,31 +628,31 @@

                                                                      Parameters

                                                                      Returns this

                                                                      v0.9.4

                                                                      -

                                                                    • By default EventEmitters will print a warning if more than 10 listeners are +

                                                                    Returns this

                                                                    v0.9.4

                                                                    +

                                                                    • By default EventEmitters will print a warning if more than 10 listeners are added for a particular event. This is a useful default that helps finding memory leaks. The emitter.setMaxListeners() method allows the limit to be modified for this specific EventEmitter instance. The value can be set to Infinity (or 0) to indicate an unlimited number of listeners.

                                                                      Returns a reference to the EventEmitter, so that calls can be chained.

                                                                      -

                                                                      Parameters

                                                                      • n: number

                                                                      Returns this

                                                                      v0.3.5

                                                                      -

                                                                    • Calls message.socket.setTimeout(msecs, callback).

                                                                      -

                                                                      Parameters

                                                                      • msecs: number
                                                                      • Optionalcallback: () => void

                                                                      Returns this

                                                                      v0.5.9

                                                                      -

                                                                    • This method is similar to Array.prototype.some and calls fn on each chunk in the stream +

                                                                      Parameters

                                                                      • n: number

                                                                      Returns this

                                                                      v0.3.5

                                                                      +

                                                                    • Calls message.socket.setTimeout(msecs, callback).

                                                                      +

                                                                      Parameters

                                                                      • msecs: number
                                                                      • Optionalcallback: () => void

                                                                      Returns this

                                                                      v0.5.9

                                                                      +

                                                                    • This method is similar to Array.prototype.some and calls fn on each chunk in the stream until the awaited return value is true (or any truthy value). Once an fn call on a chunk awaited return value is truthy, the stream is destroyed and the promise is fulfilled with true. If none of the fn calls on the chunks return a truthy value, the promise is fulfilled with false.

                                                                      Parameters

                                                                      • fn: (
                                                                            data: any,
                                                                            options?: Pick<Stream.ArrayOptions, "signal">,
                                                                        ) => boolean | Promise<boolean>

                                                                        a function to call on each chunk of the stream. Async or not.

                                                                        -
                                                                      • Optionaloptions: Stream.ArrayOptions

                                                                      Returns Promise<boolean>

                                                                      a promise evaluating to true if fn returned a truthy value for at least one of the chunks.

                                                                      -

                                                                      v17.5.0

                                                                      -

                                                                    Returns Promise<boolean>

                                                                    a promise evaluating to true if fn returned a truthy value for at least one of the chunks.

                                                                    v17.5.0

                                                                    +

                                                                    • This method returns a new stream with the first limit chunks.

                                                                      +

                                                                      Parameters

                                                                      • limit: number

                                                                        the number of chunks to take from the readable.

                                                                        +
                                                                      • Optionaloptions: Pick<Stream.ArrayOptions, "signal">

                                                                      Returns Readable

                                                                      a stream with limit chunks taken.

                                                                      +

                                                                      v17.5.0

                                                                    • This method allows easily obtaining the contents of a stream.

                                                                      As this method reads the entire stream into memory, it negates the benefits of streams. It's intended for interoperability and convenience, not as the primary way to consume streams.

                                                                      Parameters

                                                                      Returns Promise<any[]>

                                                                      a promise containing an array with the contents of the stream.

                                                                      -

                                                                      v17.5.0

                                                                      +

                                                                      v17.5.0

                                                                    • The readable.unpipe() method detaches a Writable stream previously attached using the pipe method.

                                                                      If the destination is not specified, then all pipes are detached.

                                                                      @@ -659,8 +662,8 @@

                                                                      Parameters

                                                                      • Optionaldestination: WritableStream

                                                                        Optional specific stream to unpipe

                                                                        -

                                                                      Returns this

                                                                      v0.9.4

                                                                      -

                                                                    • Passing chunk as null signals the end of the stream (EOF) and behaves the +

                                                                    Returns this

                                                                    v0.9.4

                                                                    +

                                                                    • Passing chunk as null signals the end of the stream (EOF) and behaves the same as readable.push(null), after which no more data can be written. The EOF signal is put at the end of the buffer and any buffered data will still be flushed.

                                                                      @@ -684,8 +687,8 @@ process of performing a read.

                                                                      Parameters

                                                                      • chunk: any

                                                                        Chunk of data to unshift onto the read queue. For streams not operating in object mode, chunk must be a {string}, {Buffer}, {TypedArray}, {DataView} or null. For object mode streams, chunk may be any JavaScript value.

                                                                        -
                                                                      • Optionalencoding: BufferEncoding

                                                                        Encoding of string chunks. Must be a valid Buffer encoding, such as 'utf8' or 'ascii'.

                                                                        -

                                                                      Returns void

                                                                      v0.9.11

                                                                      +
                                                                    • Optionalencoding: BufferEncoding

                                                                      Encoding of string chunks. Must be a valid Buffer encoding, such as 'utf8' or 'ascii'.

                                                                      +

                                                                    Returns void

                                                                    v0.9.11

                                                                    • Prior to Node.js 0.10, streams did not implement the entire node:stream module API as it is currently defined. (See Compatibility for more information.)

                                                                      When using an older Node.js library that emits 'data' events and has a pause method that is advisory only, the readable.wrap() method can be used to create a Readable @@ -698,8 +701,8 @@

                                                                      Parameters

                                                                      Returns this

                                                                      v0.9.4

                                                                      -

                                                                    • Listens once to the abort event on the provided signal.

                                                                      +

                                                                    Returns this

                                                                    v0.9.4

                                                                    +

                                                                    • Listens once to the abort event on the provided signal.

                                                                      Listening to the abort event on abort signals is unsafe and may lead to resource leaks since another third party with the signal can call e.stopImmediatePropagation(). Unfortunately Node.js cannot change @@ -713,13 +716,13 @@

                                                                      Parameters

                                                                      Returns Disposable

                                                                      Disposable that removes the abort listener.

                                                                      -

                                                                      v20.5.0

                                                                      -

                                                                    • A utility method for creating Readable Streams out of iterators.

                                                                      Parameters

                                                                      • iterable: Iterable<any, any, any> | AsyncIterable<any, any, any>

                                                                        Object implementing the Symbol.asyncIterator or Symbol.iterator iterable protocol. Emits an 'error' event if a null value is passed.

                                                                        -
                                                                      • Optionaloptions: Stream.ReadableOptions

                                                                        Options provided to new stream.Readable([options]). By default, Readable.from() will set options.objectMode to true, unless this is explicitly opted out by setting options.objectMode to false.

                                                                        -

                                                                      Returns Readable

                                                                      v12.3.0, v10.17.0

                                                                      +
                                                                    • Optionaloptions: Stream.ReadableOptions

                                                                      Options provided to new stream.Readable([options]). By default, Readable.from() will set options.objectMode to true, unless this is explicitly opted out by setting options.objectMode to false.

                                                                      +

                                                                    Returns Readable

                                                                    v12.3.0, v10.17.0

                                                                    • A utility method for creating a Readable from a web ReadableStream.

                                                                      -

                                                                      Parameters

                                                                      • readableStream: ReadableStream
                                                                      • Optionaloptions: Pick<
                                                                            Stream.ReadableOptions,
                                                                            "encoding"
                                                                            | "highWaterMark"
                                                                            | "objectMode"
                                                                            | "signal",
                                                                        >

                                                                      Returns Readable

                                                                      v17.0.0

                                                                      +

                                                                      Parameters

                                                                      • readableStream: ReadableStream
                                                                      • Optionaloptions: Pick<
                                                                            Stream.ReadableOptions,
                                                                            "encoding"
                                                                            | "highWaterMark"
                                                                            | "objectMode"
                                                                            | "signal",
                                                                        >

                                                                      Returns Readable

                                                                      v17.0.0

                                                                    • Returns a copy of the array of listeners for the event named eventName.

                                                                      For EventEmitters this behaves exactly the same as calling .listeners on the emitter.

                                                                      @@ -728,8 +731,8 @@ 
                                                                      import { getEventListeners, EventEmitter } from 'node:events';

                                                                      {
                                                                        const ee = new EventEmitter();
                                                                        const listener = () => console.log('Events are fun');
                                                                        ee.on('foo', listener);
                                                                        console.log(getEventListeners(ee, 'foo')); // [ [Function: listener] ]
                                                                      }
                                                                      {
                                                                        const et = new EventTarget();
                                                                        const listener = () => console.log('Events are fun');
                                                                        et.addEventListener('foo', listener);
                                                                        console.log(getEventListeners(et, 'foo')); // [ [Function: listener] ]
                                                                      }
                                                                      -

                                                                      Parameters

                                                                      Returns Function[]

                                                                      v15.2.0, v14.17.0

                                                                      -

                                                                    • Returns the currently set max amount of listeners.

                                                                      For EventEmitters this behaves exactly the same as calling .getMaxListeners on the emitter.

                                                                      For EventTargets this is the only way to get the max event listeners for the @@ -738,18 +741,18 @@ 

                                                                      import { getMaxListeners, setMaxListeners, EventEmitter } from 'node:events';

                                                                      {
                                                                        const ee = new EventEmitter();
                                                                        console.log(getMaxListeners(ee)); // 10
                                                                        setMaxListeners(11, ee);
                                                                        console.log(getMaxListeners(ee)); // 11
                                                                      }
                                                                      {
                                                                        const et = new EventTarget();
                                                                        console.log(getMaxListeners(et)); // 10
                                                                        setMaxListeners(11, et);
                                                                        console.log(getMaxListeners(et)); // 11
                                                                      }
                                                                      -

                                                                      Parameters

                                                                      Returns number

                                                                      v19.9.0

                                                                      -

                                                                    • A class method that returns the number of listeners for the given eventName registered on the given emitter.

                                                                      import { EventEmitter, listenerCount } from 'node:events';

                                                                      const myEmitter = new EventEmitter();
                                                                      myEmitter.on('event', () => {});
                                                                      myEmitter.on('event', () => {});
                                                                      console.log(listenerCount(myEmitter, 'event'));
                                                                      // Prints: 2

                                                                      Parameters

                                                                      • emitter: EventEmitter

                                                                        The emitter to query

                                                                        -
                                                                      • eventName: string | symbol

                                                                        The event name

                                                                        -

                                                                      Returns number

                                                                      v0.9.12

                                                                      +
                                                                    • eventName: string | symbol

                                                                      The event name

                                                                      +

                                                                    Returns number

                                                                    v0.9.12

                                                                    Since v3.2.0 - Use listenerCount instead.

                                                                    -
                                                                    • import { on, EventEmitter } from 'node:events';
                                                                      import process from 'node:process';

                                                                      const ee = new EventEmitter();

                                                                      // Emit later on
                                                                      process.nextTick(() => {
                                                                        ee.emit('foo', 'bar');
                                                                        ee.emit('foo', 42);
                                                                      });

                                                                      for await (const event of on(ee, 'foo')) {
                                                                        // The execution of this inner block is synchronous and it
                                                                        // processes one event at a time (even with await). Do not use
                                                                        // if concurrent execution is required.
                                                                        console.log(event); // prints ['bar'] [42]
                                                                      }
                                                                      // Unreachable here
+
                                                                    • import { on, EventEmitter } from 'node:events';
                                                                      import process from 'node:process';

                                                                      const ee = new EventEmitter();

                                                                      // Emit later on
                                                                      process.nextTick(() => {
                                                                        ee.emit('foo', 'bar');
                                                                        ee.emit('foo', 42);
                                                                      });

                                                                      for await (const event of on(ee, 'foo')) {
                                                                        // The execution of this inner block is synchronous and it
                                                                        // processes one event at a time (even with await). Do not use
                                                                        // if concurrent execution is required.
                                                                        console.log(event); // prints ['bar'] [42]
                                                                      }
                                                                      // Unreachable here

                                                                      Returns an AsyncIterator that iterates eventName events. It will throw @@ -765,8 +768,8 @@

                                                                      Parameters

                                                                      Returns AsyncIterator<any[]>

                                                                      An AsyncIterator that iterates eventName events emitted by the emitter

                                                                      -

                                                                      v13.6.0, v12.16.0

                                                                      -
                                                                    • import { on, EventEmitter } from 'node:events';
                                                                      import process from 'node:process';

                                                                      const ee = new EventEmitter();

                                                                      // Emit later on
                                                                      process.nextTick(() => {
                                                                        ee.emit('foo', 'bar');
                                                                        ee.emit('foo', 42);
                                                                      });

                                                                      for await (const event of on(ee, 'foo')) {
                                                                        // The execution of this inner block is synchronous and it
                                                                        // processes one event at a time (even with await). Do not use
                                                                        // if concurrent execution is required.
                                                                        console.log(event); // prints ['bar'] [42]
                                                                      }
                                                                      // Unreachable here
+
                                                                      v13.6.0, v12.16.0
                                                                      
+
                                                                    • import { on, EventEmitter } from 'node:events';
                                                                      import process from 'node:process';

                                                                      const ee = new EventEmitter();

                                                                      // Emit later on
                                                                      process.nextTick(() => {
                                                                        ee.emit('foo', 'bar');
                                                                        ee.emit('foo', 42);
                                                                      });

                                                                      for await (const event of on(ee, 'foo')) {
                                                                        // The execution of this inner block is synchronous and it
                                                                        // processes one event at a time (even with await). Do not use
                                                                        // if concurrent execution is required.
                                                                        console.log(event); // prints ['bar'] [42]
                                                                      }
                                                                      // Unreachable here

                                                                      Returns an AsyncIterator that iterates eventName events. It will throw @@ -782,8 +785,8 @@

                                                                      Parameters

                                                                      Returns AsyncIterator<any[]>

                                                                      An AsyncIterator that iterates eventName events emitted by the emitter

                                                                      -

                                                                      v13.6.0, v12.16.0

                                                                      -

                                                                    • Creates a Promise that is fulfilled when the EventEmitter emits the given +

                                                                      v13.6.0, v12.16.0

                                                                      +

                                                                    • Creates a Promise that is fulfilled when the EventEmitter emits the given event or that is rejected if the EventEmitter emits 'error' while waiting. The Promise will resolve with an array of all the arguments emitted to the given event.

                                                                      @@ -802,8 +805,8 @@ 
                                                                      import { EventEmitter, once } from 'node:events';

                                                                      const ee = new EventEmitter();
                                                                      const ac = new AbortController();

                                                                      async function foo(emitter, event, signal) {
                                                                        try {
                                                                          await once(emitter, event, { signal });
                                                                          console.log('event emitted!');
                                                                        } catch (error) {
                                                                          if (error.name === 'AbortError') {
                                                                            console.error('Waiting for the event was canceled!');
                                                                          } else {
                                                                            console.error('There was an error', error.message);
                                                                          }
                                                                        }
                                                                      }

                                                                      foo(ee, 'foo', ac.signal);
                                                                      ac.abort(); // Abort waiting for the event
                                                                      ee.emit('foo'); // Prints: Waiting for the event was canceled!
                                                                      -

                                                                      Parameters

                                                                      Returns Promise<any[]>

                                                                      v11.13.0, v10.16.0

                                                                      -

                                                                    • Creates a Promise that is fulfilled when the EventEmitter emits the given +

                                                                      Parameters

                                                                      Returns Promise<any[]>

                                                                      v11.13.0, v10.16.0

                                                                      +

                                                                    • Creates a Promise that is fulfilled when the EventEmitter emits the given event or that is rejected if the EventEmitter emits 'error' while waiting. The Promise will resolve with an array of all the arguments emitted to the given event.

                                                                      @@ -822,14 +825,14 @@ 
                                                                      import { EventEmitter, once } from 'node:events';

                                                                      const ee = new EventEmitter();
                                                                      const ac = new AbortController();

                                                                      async function foo(emitter, event, signal) {
                                                                        try {
                                                                          await once(emitter, event, { signal });
                                                                          console.log('event emitted!');
                                                                        } catch (error) {
                                                                          if (error.name === 'AbortError') {
                                                                            console.error('Waiting for the event was canceled!');
                                                                          } else {
                                                                            console.error('There was an error', error.message);
                                                                          }
                                                                        }
                                                                      }

                                                                      foo(ee, 'foo', ac.signal);
                                                                      ac.abort(); // Abort waiting for the event
                                                                      ee.emit('foo'); // Prints: Waiting for the event was canceled!
                                                                      -

                                                                      Parameters

                                                                      Returns Promise<any[]>

                                                                      v11.13.0, v10.16.0

                                                                      -
                                                                    • import { setMaxListeners, EventEmitter } from 'node:events';

                                                                      const target = new EventTarget();
                                                                      const emitter = new EventEmitter();

                                                                      setMaxListeners(5, target, emitter);
+

                                                                      Parameters

                                                                      Returns Promise<any[]>

                                                                      v11.13.0, v10.16.0

                                                                      +
                                                                    • import { setMaxListeners, EventEmitter } from 'node:events';

                                                                      const target = new EventTarget();
                                                                      const emitter = new EventEmitter();

                                                                      setMaxListeners(5, target, emitter);

                                                                      Parameters

                                                                      • Optionaln: number

                                                                        A non-negative number. The maximum number of listeners per EventTarget event.

                                                                        -
                                                                      • ...eventTargets: (EventEmitter<DefaultEventMap> | EventTarget)[]

                                                                        Zero or more {EventTarget} or {EventEmitter} instances. If none are specified, n is set as the default max for all newly created {EventTarget} and {EventEmitter} +

                                                                      • ...eventTargets: (EventEmitter<DefaultEventMap> | EventTarget)[]

                                                                        Zero or more {EventTarget} or {EventEmitter} instances. If none are specified, n is set as the default max for all newly created {EventTarget} and {EventEmitter} objects.

                                                                        -

                                                                      Returns void

                                                                      v15.4.0

                                                                      -

                                                                    Returns void

                                                                    v15.4.0

                                                                    +

                                                                    Settings

                                                                    Member Visibility

                                                                    On This Page

                                                                    Constructors
                                                                    Properties
                                                                    Methods
                                                                    diff --git a/docs/classes/_internal_.LazyServiceIdentifier.html b/docs/classes/_internal_.LazyServiceIdentifier.html index 9b3b0df1..0590fb63 100644 --- a/docs/classes/_internal_.LazyServiceIdentifier.html +++ b/docs/classes/_internal_.LazyServiceIdentifier.html @@ -2,4 +2,4 @@

                                                                    Properties

                                                                    [islazyServiceIdentifierSymbol]

                                                                    Methods

                                                                    unwrap is -

                                                                    Constructors

                                                                    Properties

                                                                    "[islazyServiceIdentifierSymbol]": true

                                                                    Methods

                                                                    Settings

                                                                    Member Visibility

                                                                    On This Page

                                                                    Constructors
                                                                    Properties
                                                                    Methods
                                                                    +

                                                                    Constructors

                                                                    Properties

                                                                    "[islazyServiceIdentifierSymbol]": true

                                                                    Methods

                                                                    Settings

                                                                    Member Visibility

                                                                    On This Page

                                                                    Constructors
                                                                    Properties
                                                                    Methods
                                                                    diff --git a/docs/classes/_internal_.LineCounter.html b/docs/classes/_internal_.LineCounter.html index daa2a047..85765231 100644 --- a/docs/classes/_internal_.LineCounter.html +++ b/docs/classes/_internal_.LineCounter.html @@ -1,13 +1,13 @@ LineCounter | ts-lambda-api - v2.5.2
                                                                    ts-lambda-api - v2.5.2
                                                                      Preparing search index...

                                                                      Class LineCounter

                                                                      Tracks newlines during parsing in order to provide an efficient API for determining the one-indexed { line, col } position for any offset within the input.

                                                                      -
                                                                      Index

                                                                      Constructors

                                                                      constructor +
                                                                      Index

                                                                      Constructors

                                                                      constructor

                                                                      Properties

                                                                      addNewLine linePos lineStarts

                                                                      Constructors

                                                                      Properties

                                                                      addNewLine: (offset: number) => number

                                                                      Should be called in ascending order. Otherwise, call lineCounter.lineStarts.sort() before calling linePos().

                                                                      -
                                                                      linePos: (offset: number) => { col: number; line: number }

                                                                      Performs a binary search and returns the 1-indexed { line, col } +

                                                                      linePos: (offset: number) => { col: number; line: number }

                                                                      Performs a binary search and returns the 1-indexed { line, col } position of offset. If line === 0, addNewLine has never been called or offset is before the first known newline.

                                                                      -
                                                                      lineStarts: number[]

                                                                      Settings

                                                                      Member Visibility

                                                                      On This Page

                                                                      Constructors
                                                                      Properties
                                                                      +
                                                                      lineStarts: number[]

                                                                      Settings

                                                                      Member Visibility

                                                                      On This Page

                                                                      Constructors
                                                                      Properties
                                                                      diff --git a/docs/classes/_internal_.NodeBase.html b/docs/classes/_internal_.NodeBase.html index a6075dba..a9755f59 100644 --- a/docs/classes/_internal_.NodeBase.html +++ b/docs/classes/_internal_.NodeBase.html @@ -1,4 +1,4 @@ -NodeBase | ts-lambda-api - v2.5.2
                                                                      ts-lambda-api - v2.5.2
                                                                        Preparing search index...

                                                                        Class NodeBaseAbstract

                                                                        Hierarchy (View Summary)

                                                                        Index

                                                                        Constructors

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

                                                                          Class NodeBaseAbstract

                                                                          Hierarchy (View Summary)

                                                                          Index

                                                                          Constructors

                                                                          constructor

                                                                          Properties

                                                                          [NODE_TYPE] addToJSMap? comment? @@ -13,16 +13,16 @@ toString

                                                                          Constructors

                                                                          • Parameters

                                                                            • type: symbol

                                                                            Returns NodeBase

                                                                          Properties

                                                                          "[NODE_TYPE]": symbol
                                                                          addToJSMap?: (ctx: ToJSContext, map: MapLike, value: unknown) => void

                                                                          Customize the way that a key-value pair is resolved. Used for YAML 1.1 !!merge << handling.

                                                                          -
                                                                          comment?: string

                                                                          A comment on or immediately after this

                                                                          -
                                                                          commentBefore?: string

                                                                          A comment before this

                                                                          -
                                                                          range?: Range

                                                                          The [start, value-end, node-end] character offsets for the part of the +

                                                                          comment?: string

                                                                          A comment on or immediately after this

                                                                          +
                                                                          commentBefore?: string

                                                                          A comment before this

                                                                          +
                                                                          range?: Range

                                                                          The [start, value-end, node-end] character offsets for the part of the source parsed into this node (undefined if not parsed). The value-end and node-end positions are themselves not included in their respective ranges.

                                                                          -
                                                                          spaceBefore?: boolean

                                                                          A blank line before this node and its commentBefore

                                                                          -
                                                                          srcToken?: Token

                                                                          The CST token that was composed into this node.

                                                                          -
                                                                          tag?: string

                                                                          A fully qualified tag, if required

                                                                          -

                                                                          Methods

                                                                          • Create a copy of this node.

                                                                            -

                                                                            Returns NodeBase

                                                                          • A plain JavaScript representation of this node.

                                                                            -

                                                                            Parameters

                                                                            Returns any

                                                                          • A plain JS representation of this node

                                                                            -

                                                                            Returns any

                                                                          • Parameters

                                                                            • Optionalctx: StringifyContext
                                                                            • OptionalonComment: () => void
                                                                            • OptionalonChompKeep: () => void

                                                                            Returns string

                                                                          Settings

                                                                          Member Visibility

                                                                          On This Page

                                                                          Constructors
                                                                          Properties
                                                                          Methods
                                                                          +
                                                                          spaceBefore?: boolean

                                                                          A blank line before this node and its commentBefore

                                                                          +
                                                                          srcToken?: Token

                                                                          The CST token that was composed into this node.

                                                                          +
                                                                          tag?: string

                                                                          A fully qualified tag, if required

                                                                          +

                                                                          Methods

                                                                          • Create a copy of this node.

                                                                            +

                                                                            Returns NodeBase

                                                                          • A plain JavaScript representation of this node.

                                                                            +

                                                                            Parameters

                                                                            Returns any

                                                                          • A plain JS representation of this node

                                                                            +

                                                                            Returns any

                                                                          • Parameters

                                                                            • Optionalctx: StringifyContext
                                                                            • OptionalonComment: () => void
                                                                            • OptionalonChompKeep: () => void

                                                                            Returns string

                                                                          Settings

                                                                          Member Visibility

                                                                          On This Page

                                                                          Constructors
                                                                          Properties
                                                                          Methods
                                                                          diff --git a/docs/classes/_internal_.OutgoingMessage.html b/docs/classes/_internal_.OutgoingMessage.html index 00b5bd85..d6245ea8 100644 --- a/docs/classes/_internal_.OutgoingMessage.html +++ b/docs/classes/_internal_.OutgoingMessage.html @@ -1,7 +1,7 @@ OutgoingMessage | ts-lambda-api - v2.5.2
                                                                          ts-lambda-api - v2.5.2
                                                                            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 @@ -32,6 +32,7 @@ _final _write _writev? +[asyncDispose] [captureRejectionSymbol]? addListener addTrailers @@ -76,52 +77,52 @@ once setMaxListeners toWeb -

                                                                            Constructors

                                                                            Properties

                                                                            chunkedEncoding: boolean
                                                                            closed: boolean

                                                                            Is true after 'close' has been emitted.

                                                                            +

                                                                            Constructors

                                                                            Properties

                                                                            chunkedEncoding: boolean
                                                                            closed: boolean

                                                                            Is true after 'close' has been emitted.

                                                                            v18.0.0

                                                                            -
                                                                            connection: Socket

                                                                            Alias of outgoingMessage.socket.

                                                                            +
                                                                            connection: Socket

                                                                            Alias of outgoingMessage.socket.

                                                                            v0.3.0

                                                                            Since v15.12.0,v14.17.1 - Use socket instead.

                                                                            -
                                                                            destroyed: boolean

                                                                            Is true after writable.destroy() has been called.

                                                                            +
                                                                            destroyed: boolean

                                                                            Is true after writable.destroy() has been called.

                                                                            v8.0.0

                                                                            -
                                                                            errored: Error

                                                                            Returns error if the stream has been destroyed with an error.

                                                                            +
                                                                            errored: Error

                                                                            Returns error if the stream has been destroyed with an error.

                                                                            v18.0.0

                                                                            -
                                                                            finished: boolean

                                                                            Use writableEnded instead.

                                                                            -
                                                                            headersSent: boolean

                                                                            Read-only. true if the headers were sent, otherwise false.

                                                                            +
                                                                            finished: boolean

                                                                            Use writableEnded instead.

                                                                            +
                                                                            headersSent: boolean

                                                                            Read-only. true if the headers were sent, otherwise false.

                                                                            v0.9.3

                                                                            -
                                                                            req: Request
                                                                            sendDate: boolean
                                                                            shouldKeepAlive: boolean
                                                                            socket: Socket

                                                                            Reference to the underlying socket. Usually, users will not want to access +

                                                                            req: Request
                                                                            sendDate: boolean
                                                                            shouldKeepAlive: boolean
                                                                            socket: Socket

                                                                            Reference to the underlying socket. Usually, users will not want to access this property.

                                                                            After calling outgoingMessage.end(), this property will be nulled.

                                                                            v0.3.0

                                                                            -
                                                                            useChunkedEncodingByDefault: boolean
                                                                            writable: boolean

                                                                            Is true if it is safe to call writable.write(), which means +

                                                                            useChunkedEncodingByDefault: boolean
                                                                            writable: boolean

                                                                            Is true if it is safe to call writable.write(), which means the stream has not been destroyed, errored, or ended.

                                                                            v11.4.0

                                                                            -
                                                                            writableAborted: boolean

                                                                            Returns whether the stream was destroyed or errored before emitting 'finish'.

                                                                            +
                                                                            writableAborted: boolean

                                                                            Returns whether the stream was destroyed or errored before emitting 'finish'.

                                                                            v18.0.0, v16.17.0

                                                                            -
                                                                            writableCorked: number

                                                                            Number of times writable.uncork() needs to be +

                                                                            writableCorked: number

                                                                            Number of times writable.uncork() needs to be called in order to fully uncork the stream.

                                                                            v13.2.0, v12.16.0

                                                                            -
                                                                            writableEnded: boolean

                                                                            Is true after writable.end() has been called. This property +

                                                                            writableEnded: boolean

                                                                            Is true after writable.end() has been called. This property does not indicate whether the data has been flushed, for this use writable.writableFinished instead.

                                                                            v12.9.0

                                                                            -
                                                                            writableFinished: boolean

                                                                            Is set to true immediately before the 'finish' event is emitted.

                                                                            +
                                                                            writableFinished: boolean

                                                                            Is set to true immediately before the 'finish' event is emitted.

                                                                            v12.6.0

                                                                            -
                                                                            writableHighWaterMark: number

                                                                            Return the value of highWaterMark passed when creating this Writable.

                                                                            +
                                                                            writableHighWaterMark: number

                                                                            Return the value of highWaterMark passed when creating this Writable.

                                                                            v9.3.0

                                                                            -
                                                                            writableLength: number

                                                                            This property contains the number of bytes (or objects) in the queue +

                                                                            writableLength: number

                                                                            This property contains the number of bytes (or objects) in the queue ready to be written. The value provides introspection data regarding the status of the highWaterMark.

                                                                            v9.4.0

                                                                            -
                                                                            writableNeedDrain: boolean

                                                                            Is true if the stream's buffer has been full and stream will emit 'drain'.

                                                                            +
                                                                            writableNeedDrain: boolean

                                                                            Is true if the stream's buffer has been full and stream will emit 'drain'.

                                                                            v15.2.0, v14.17.0

                                                                            -
                                                                            writableObjectMode: boolean

                                                                            Getter for the property objectMode of a given Writable stream.

                                                                            +
                                                                            writableObjectMode: boolean

                                                                            Getter for the property objectMode of a given Writable stream.

                                                                            v12.3.0

                                                                            -
                                                                            captureRejections: boolean

                                                                            Value: boolean

                                                                            +
                                                                            captureRejections: boolean

                                                                            Value: boolean

                                                                            Change the default captureRejections option on all new EventEmitter objects.

                                                                            v13.4.0, v12.16.0

                                                                            -
                                                                            captureRejectionSymbol: typeof captureRejectionSymbol

                                                                            Value: Symbol.for('nodejs.rejection')

                                                                            +
                                                                            captureRejectionSymbol: typeof captureRejectionSymbol

                                                                            Value: Symbol.for('nodejs.rejection')

                                                                            See how to write a custom rejection handler.

                                                                            v13.4.0, v12.16.0

                                                                            -
                                                                            defaultMaxListeners: number

                                                                            By default, a maximum of 10 listeners can be registered for any single +

                                                                            defaultMaxListeners: number

                                                                            By default, a maximum of 10 listeners can be registered for any single event. This limit can be changed for individual EventEmitter instances using the emitter.setMaxListeners(n) method. To change the default for allEventEmitter instances, the events.defaultMaxListeners property @@ -146,11 +147,14 @@ listeners, respectively. Its name property is set to 'MaxListenersExceededWarning'.

                                                                            v0.11.2

                                                                            -
                                                                            errorMonitor: typeof errorMonitor

                                                                            This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

                                                                            +
                                                                            errorMonitor: typeof errorMonitor

                                                                            This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

                                                                            Installing a listener using this symbol does not change the behavior once an 'error' event is emitted. Therefore, the process will still crash if no regular 'error' listener is installed.

                                                                            v13.6.0, v12.17.0

                                                                            -

                                                                            Methods

                                                                            Optional_construct

                                                                            • _construct(callback: (error?: Error) => void): void

                                                                              Parameters

                                                                              • callback: (error?: Error) => void

                                                                              Returns void

                                                                            _destroy

                                                                            • _destroy(error: Error, callback: (error?: Error) => void): void

                                                                              Parameters

                                                                              • error: Error
                                                                              • callback: (error?: Error) => void

                                                                              Returns void

                                                                            _final

                                                                            • _final(callback: (error?: Error) => void): void

                                                                              Parameters

                                                                              • callback: (error?: Error) => void

                                                                              Returns void

                                                                            _write

                                                                            • _write(
                                                                                  chunk: any,
                                                                                  encoding: BufferEncoding,
                                                                                  callback: (error?: Error) => void,
                                                                              ): void

                                                                              Parameters

                                                                              Returns void

                                                                            Optional_writev

                                                                            • _writev(
                                                                                  chunks: { chunk: any; encoding: BufferEncoding }[],
                                                                                  callback: (error?: Error) => void,
                                                                              ): void

                                                                              Parameters

                                                                              • chunks: { chunk: any; encoding: BufferEncoding }[]
                                                                              • callback: (error?: Error) => void

                                                                              Returns void

                                                                            • Type Parameters

                                                                              • K

                                                                              Parameters

                                                                              • error: Error
                                                                              • event: string | symbol
                                                                              • ...args: AnyRest

                                                                              Returns void

                                                                            • Event emitter +

                                                                            Methods

                                                                            Optional_construct

                                                                            • _construct?(callback: (error?: Error) => void): void

                                                                              Parameters

                                                                              • callback: (error?: Error) => void

                                                                              Returns void

                                                                            _destroy

                                                                            • _destroy(error: Error, callback: (error?: Error) => void): void

                                                                              Parameters

                                                                              • error: Error
                                                                              • callback: (error?: Error) => void

                                                                              Returns void

                                                                            _final

                                                                            • _final(callback: (error?: Error) => void): void

                                                                              Parameters

                                                                              • callback: (error?: Error) => void

                                                                              Returns void

                                                                            _write

                                                                            • _write(
                                                                                  chunk: any,
                                                                                  encoding: BufferEncoding,
                                                                                  callback: (error?: Error) => void,
                                                                              ): void

                                                                              Parameters

                                                                              Returns void

                                                                            Optional_writev

                                                                            • _writev?(
                                                                                  chunks: { chunk: any; encoding: BufferEncoding }[],
                                                                                  callback: (error?: Error) => void,
                                                                              ): void

                                                                              Parameters

                                                                              • chunks: { chunk: any; encoding: BufferEncoding }[]
                                                                              • callback: (error?: Error) => void

                                                                              Returns void

                                                                            • Calls writable.destroy() with an AbortError and returns +a promise that fulfills when the stream is finished.

                                                                              +

                                                                              Returns Promise<void>

                                                                              v22.4.0, v20.16.0

                                                                              +

                                                                            • Type Parameters

                                                                              • K

                                                                              Parameters

                                                                              • error: Error
                                                                              • event: string | symbol
                                                                              • ...args: AnyRest

                                                                              Returns void

                                                                            • Event emitter The defined events on documents including:

                                                                              1. close
                                                                                2. @@ -160,7 +164,7 @@
                                                                              2. pipe
                                                                              3. unpipe
                                                                              -

                                                                              Parameters

                                                                              • event: "close"
                                                                              • listener: () => void

                                                                              Returns this

                                                                            • Event emitter +

                                                                              Parameters

                                                                              • event: "close"
                                                                              • listener: () => void

                                                                              Returns this

                                                                            • Event emitter The defined events on documents including:

                                                                              1. close
                                                                                2. @@ -170,7 +174,7 @@
                                                                              2. pipe
                                                                              3. unpipe
                                                                              -

                                                                              Parameters

                                                                              • event: "drain"
                                                                              • listener: () => void

                                                                              Returns this

                                                                            • Event emitter +

                                                                              Parameters

                                                                              • event: "drain"
                                                                              • listener: () => void

                                                                              Returns this

                                                                            • Event emitter The defined events on documents including:

                                                                              1. close
                                                                                2. @@ -180,7 +184,7 @@
                                                                              2. pipe
                                                                              3. unpipe
                                                                              -

                                                                              Parameters

                                                                              • event: "error"
                                                                              • listener: (err: Error) => void

                                                                              Returns this

                                                                            • Event emitter +

                                                                              Parameters

                                                                              • event: "error"
                                                                              • listener: (err: Error) => void

                                                                              Returns this

                                                                            • Event emitter The defined events on documents including:

                                                                              1. close
                                                                                2. @@ -190,7 +194,7 @@
                                                                              2. pipe
                                                                              3. unpipe
                                                                              -

                                                                              Parameters

                                                                              • event: "finish"
                                                                              • listener: () => void

                                                                              Returns this

                                                                            • Event emitter +

                                                                              Parameters

                                                                              • event: "finish"
                                                                              • listener: () => void

                                                                              Returns this

                                                                            • Event emitter The defined events on documents including:

                                                                              1. close
                                                                                2. @@ -200,7 +204,7 @@
                                                                              2. pipe
                                                                              3. unpipe
                                                                              -

                                                                              Parameters

                                                                              • event: "pipe"
                                                                              • listener: (src: Readable) => void

                                                                              Returns this

                                                                            • Event emitter +

                                                                              Parameters

                                                                              • event: "pipe"
                                                                              • listener: (src: Readable) => void

                                                                              Returns this

                                                                            • Event emitter The defined events on documents including:

                                                                              1. close
                                                                                2. @@ -210,7 +214,7 @@
                                                                              2. pipe
                                                                              3. unpipe
                                                                              -

                                                                              Parameters

                                                                              • event: "unpipe"
                                                                              • listener: (src: Readable) => void

                                                                              Returns this

                                                                            • Event emitter +

                                                                              Parameters

                                                                              • event: "unpipe"
                                                                              • listener: (src: Readable) => void

                                                                              Returns this

                                                                            • Event emitter The defined events on documents including:

                                                                              1. close
                                                                                2. @@ -220,7 +224,7 @@
                                                                              2. pipe
                                                                              3. unpipe
                                                                              -

                                                                              Parameters

                                                                              • event: string | symbol
                                                                              • listener: (...args: any[]) => void

                                                                              Returns this

                                                                            • Adds HTTP trailers (headers but at the end of the message) to the message.

                                                                              +

                                                                              Parameters

                                                                              • event: string | symbol
                                                                              • listener: (...args: any[]) => void

                                                                              Returns this

                                                                            • Adds HTTP trailers (headers but at the end of the message) to the message.

                                                                              Trailers will only be emitted if the message is chunked encoded. If not, the trailers will be silently discarded.

                                                                              HTTP requires the Trailer header to be sent to emit trailers, @@ -230,8 +234,8 @@

                                                                              Attempting to set a header field name or value that contains invalid characters will result in a TypeError being thrown.

                                                                              -

                                                                              Parameters

                                                                              Returns void

                                                                              v0.3.0

                                                                              -

                                                                            • Append a single header value to the header object.

                                                                              +

                                                                              Parameters

                                                                              Returns void

                                                                              v0.3.0

                                                                              +

                                                                            • Append a single header value to the header object.

                                                                              If the value is an array, this is equivalent to calling this method multiple times.

                                                                              If there were no previous values for the header, this is equivalent to calling outgoingMessage.setHeader(name, value).

                                                                              @@ -239,9 +243,9 @@ server were created, this will end up in the header being sent multiple times or a single time with values joined using ; .

                                                                              Parameters

                                                                              • name: string

                                                                                Header name

                                                                                -
                                                                              • value: string | readonly string[]

                                                                                Header value

                                                                                -

                                                                              Returns this

                                                                              v18.3.0, v16.17.0

                                                                              -

                                                                            • The writable.cork() method forces all written data to be buffered in memory. +

                                                                            • value: string | readonly string[]

                                                                              Header value

                                                                              +

                                                                            Returns this

                                                                            v18.3.0, v16.17.0

                                                                            +

                                                                            • The writable.cork() method forces all written data to be buffered in memory. The buffered data will be flushed when either the uncork or end methods are called.

                                                                              The primary intent of writable.cork() is to accommodate a situation in which several small chunks are written to the stream in rapid succession. Instead of @@ -250,8 +254,8 @@ situation where data is being buffered while waiting for the first small chunk to be processed. However, use of writable.cork() without implementing writable._writev() may have an adverse effect on throughput.

                                                                              See also: writable.uncork(), writable._writev().

                                                                              -

                                                                              Returns void

                                                                              v0.11.2

                                                                              -

                                                                            • Destroy the stream. Optionally emit an 'error' event, and emit a 'close' event (unless emitClose is set to false). After this call, the writable +

                                                                              Returns void

                                                                              v0.11.2

                                                                              +

                                                                            • Destroy the stream. Optionally emit an 'error' event, and emit a 'close' event (unless emitClose is set to false). After this call, the writable stream has ended and subsequent calls to write() or end() will result in an ERR_STREAM_DESTROYED error. This is a destructive and immediate way to destroy a stream. Previous calls to write() may not have drained, and may trigger an ERR_STREAM_DESTROYED error. @@ -262,15 +266,15 @@

                                                                              Implementors should not override this method, but instead implement writable._destroy().

                                                                              Parameters

                                                                              • Optionalerror: Error

                                                                                Optional, an error to emit with 'error' event.

                                                                                -

                                                                              Returns this

                                                                              v8.0.0

                                                                              -

                                                                            • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments +

                                                                            Returns this

                                                                            v8.0.0

                                                                            +

                                                                            • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

                                                                              Returns true if the event had listeners, false otherwise.

                                                                              import { EventEmitter } from 'node:events';
                                                                              const myEmitter = new EventEmitter();

                                                                              // First listener
                                                                              myEmitter.on('event', function firstListener() {
                                                                                console.log('Helloooo! first listener');
                                                                              });
                                                                              // Second listener
                                                                              myEmitter.on('event', function secondListener(arg1, arg2) {
                                                                                console.log(`event with parameters ${arg1}, ${arg2} in second listener`);
                                                                              });
                                                                              // Third listener
                                                                              myEmitter.on('event', function thirdListener(...args) {
                                                                                const parameters = args.join(', ');
                                                                                console.log(`event with parameters ${parameters} in third listener`);
                                                                              });

                                                                              console.log(myEmitter.listeners('event'));

                                                                              myEmitter.emit('event', 1, 2, 3, 4, 5);

                                                                              // Prints:
                                                                              // [
                                                                              //   [Function: firstListener],
                                                                              //   [Function: secondListener],
                                                                              //   [Function: thirdListener]
                                                                              // ]
                                                                              // Helloooo! first listener
                                                                              // event with parameters 1, 2 in second listener
                                                                              // event with parameters 1, 2, 3, 4, 5 in third listener
                                                                              -

                                                                              Parameters

                                                                              • event: "close"

                                                                              Returns boolean

                                                                              v0.1.26

                                                                              -

                                                                            • Parameters

                                                                              • event: "drain"

                                                                              Returns boolean

                                                                            • Parameters

                                                                              • event: "error"
                                                                              • err: Error

                                                                              Returns boolean

                                                                            • Parameters

                                                                              • event: "finish"

                                                                              Returns boolean

                                                                            • Parameters

                                                                              Returns boolean

                                                                            • Parameters

                                                                              Returns boolean

                                                                            • Parameters

                                                                              • event: string | symbol
                                                                              • ...args: any[]

                                                                              Returns boolean

                                                                            • Calling the writable.end() method signals that no more data will be written +

                                                                              Parameters

                                                                              • event: "close"

                                                                              Returns boolean

                                                                              v0.1.26

                                                                              +

                                                                            • Parameters

                                                                              • event: "drain"

                                                                              Returns boolean

                                                                            • Parameters

                                                                              • event: "error"
                                                                              • err: Error

                                                                              Returns boolean

                                                                            • Parameters

                                                                              • event: "finish"

                                                                              Returns boolean

                                                                            • Parameters

                                                                              Returns boolean

                                                                            • Parameters

                                                                              Returns boolean

                                                                            • Parameters

                                                                              • event: string | symbol
                                                                              • ...args: any[]

                                                                              Returns boolean

                                                                            • Calling the writable.end() method signals that no more data will be written to the Writable. The optional chunk and encoding arguments allow one final additional chunk of data to be written immediately before closing the stream.

                                                                              @@ -278,8 +282,8 @@ 
                                                                              // Write 'hello, ' and then end with 'world!'.
                                                                              import fs from 'node:fs';
                                                                              const file = fs.createWriteStream('example.txt');
                                                                              file.write('hello, ');
                                                                              file.end('world!');
                                                                              // Writing more now is not allowed!
                                                                              -

                                                                              Parameters

                                                                              • Optionalcb: () => void

                                                                              Returns this

                                                                              v0.9.4

                                                                              -

                                                                            • Calling the writable.end() method signals that no more data will be written +

                                                                              Parameters

                                                                              • Optionalcb: () => void

                                                                              Returns this

                                                                              v0.9.4

                                                                              +

                                                                            • Calling the writable.end() method signals that no more data will be written to the Writable. The optional chunk and encoding arguments allow one final additional chunk of data to be written immediately before closing the stream.

                                                                              @@ -289,8 +293,8 @@

                                                                              Parameters

                                                                              • chunk: any

                                                                                Optional data to write. For streams not operating in object mode, chunk must be a {string}, {Buffer}, {TypedArray} or {DataView}. For object mode streams, chunk may be any JavaScript value other than null.

                                                                                -
                                                                              • Optionalcb: () => void

                                                                              Returns this

                                                                              v0.9.4

                                                                              -

                                                                            • Calling the writable.end() method signals that no more data will be written +

                                                                            • Optionalcb: () => void

                                                                            Returns this

                                                                            v0.9.4

                                                                            +

                                                                          • Calling the writable.end() method signals that no more data will be written to the Writable. The optional chunk and encoding arguments allow one final additional chunk of data to be written immediately before closing the stream.

                                                                            @@ -300,30 +304,30 @@

                                                                            Parameters

                                                                            • chunk: any

                                                                              Optional data to write. For streams not operating in object mode, chunk must be a {string}, {Buffer}, {TypedArray} or {DataView}. For object mode streams, chunk may be any JavaScript value other than null.

                                                                              -
                                                                            • encoding: BufferEncoding

                                                                              The encoding if chunk is a string

                                                                              -
                                                                            • Optionalcb: () => void

                                                                            Returns this

                                                                            v0.9.4

                                                                            -

                                                                            • Returns an array listing the events for which the emitter has registered +

                                                                            • encoding: BufferEncoding

                                                                              The encoding if chunk is a string

                                                                              +
                                                                            • Optionalcb: () => void

                                                                            Returns this

                                                                            v0.9.4

                                                                            +

                                                                            • Returns an array listing the events for which the emitter has registered listeners. The values in the array are strings or Symbols.

                                                                              import { EventEmitter } from 'node:events';

                                                                              const myEE = new EventEmitter();
                                                                              myEE.on('foo', () => {});
                                                                              myEE.on('bar', () => {});

                                                                              const sym = Symbol('symbol');
                                                                              myEE.on(sym, () => {});

                                                                              console.log(myEE.eventNames());
                                                                              // Prints: [ 'foo', 'bar', Symbol(symbol) ]
                                                                              -

                                                                              Returns (string | symbol)[]

                                                                              v6.0.0

                                                                              -

                                                                            • Flushes the message headers.

                                                                              +

                                                                              Returns (string | symbol)[]

                                                                              v6.0.0

                                                                              +

                                                                            • Flushes the message headers.

                                                                              For efficiency reason, Node.js normally buffers the message headers until outgoingMessage.end() is called or the first chunk of message data is written. It then tries to pack the headers and data into a single TCP packet.

                                                                              It is usually desired (it saves a TCP round-trip), but not when the first data is not sent until possibly much later. outgoingMessage.flushHeaders() bypasses the optimization and kickstarts the message.

                                                                              -

                                                                              Returns void

                                                                              v1.6.0

                                                                              -

                                                                            • Gets the value of the HTTP header with the given name. If that header is not +

                                                                              Returns void

                                                                              v1.6.0

                                                                              +

                                                                            • Gets the value of the HTTP header with the given name. If that header is not set, the returned value will be undefined.

                                                                              Parameters

                                                                              • name: string

                                                                                Name of header

                                                                                -

                                                                              Returns string | number | string[]

                                                                              v0.4.0

                                                                              -

                                                                            • Returns an array containing the unique names of the current outgoing headers. +

                                                                            Returns string | number | string[]

                                                                            v0.4.0

                                                                            +

                                                                            • Returns an array containing the unique names of the current outgoing headers. All names are lowercase.

                                                                              -

                                                                              Returns string[]

                                                                              v7.7.0

                                                                              -

                                                                            • Returns a shallow copy of the current outgoing headers. Since a shallow +

                                                                              Returns string[]

                                                                              v7.7.0

                                                                              +

                                                                            • Returns a shallow copy of the current outgoing headers. Since a shallow copy is used, array values may be mutated without additional calls to various header-related HTTP module methods. The keys of the returned object are the header names and the values are the respective header @@ -335,30 +339,30 @@ 

                                                                              outgoingMessage.setHeader('Foo', 'bar');
                                                                              outgoingMessage.setHeader('Set-Cookie', ['foo=bar', 'bar=baz']);

                                                                              const headers = outgoingMessage.getHeaders();
                                                                              // headers === { foo: 'bar', 'set-cookie': ['foo=bar', 'bar=baz'] }
                                                                              -

                                                                              Returns OutgoingHttpHeaders

                                                                              v7.7.0

                                                                              -

                                                                            • Returns the current max listener value for the EventEmitter which is either +

                                                                              Returns OutgoingHttpHeaders

                                                                              v7.7.0

                                                                              +

                                                                            • Returns the current max listener value for the EventEmitter which is either set by emitter.setMaxListeners(n) or defaults to EventEmitter.defaultMaxListeners.

                                                                              -

                                                                              Returns number

                                                                              v1.0.0

                                                                              -

                                                                            • Returns true if the header identified by name is currently set in the +

                                                                              Returns number

                                                                              v1.0.0

                                                                              +

                                                                            • Returns true if the header identified by name is currently set in the outgoing headers. The header name is case-insensitive.

                                                                              const hasContentType = outgoingMessage.hasHeader('content-type');
                                                                              -

                                                                              Parameters

                                                                              • name: string

                                                                              Returns boolean

                                                                              v7.7.0

                                                                              -

                                                                            • Returns the number of listeners listening for the event named eventName. +

                                                                              Parameters

                                                                              • name: string

                                                                              Returns boolean

                                                                              v7.7.0

                                                                              +

                                                                            • Returns the number of listeners listening for the event named eventName. If listener is provided, it will return how many times the listener is found in the list of the listeners of the event.

                                                                              Type Parameters

                                                                              • K

                                                                              Parameters

                                                                              • eventName: string | symbol

                                                                                The name of the event being listened for

                                                                                -
                                                                              • Optionallistener: Function

                                                                                The event handler function

                                                                                -

                                                                              Returns number

                                                                              v3.2.0

                                                                              -

                                                                            • Returns a copy of the array of listeners for the event named eventName.

                                                                              +
                                                                            • Optionallistener: Function

                                                                              The event handler function

                                                                              +

                                                                            Returns number

                                                                            v3.2.0

                                                                            +

                                                                            • Returns a copy of the array of listeners for the event named eventName.

                                                                              server.on('connection', (stream) => {
                                                                                console.log('someone connected!');
                                                                              });
                                                                              console.log(util.inspect(server.listeners('connection')));
                                                                              // Prints: [ [Function] ]
                                                                              -

                                                                              Type Parameters

                                                                              • K

                                                                              Parameters

                                                                              • eventName: string | symbol

                                                                              Returns Function[]

                                                                              v0.1.26

                                                                              -

                                                                            • Alias for emitter.removeListener().

                                                                              -

                                                                              Type Parameters

                                                                              • K

                                                                              Parameters

                                                                              • eventName: string | symbol
                                                                              • listener: (...args: any[]) => void

                                                                              Returns this

                                                                              v10.0.0

                                                                              -

                                                                            • Adds the listener function to the end of the listeners array for the event +

                                                                              Type Parameters

                                                                              • K

                                                                              Parameters

                                                                              • eventName: string | symbol

                                                                              Returns Function[]

                                                                              v0.1.26

                                                                              +

                                                                            • Alias for emitter.removeListener().

                                                                              +

                                                                              Type Parameters

                                                                              • K

                                                                              Parameters

                                                                              • eventName: string | symbol
                                                                              • listener: (...args: any[]) => void

                                                                              Returns this

                                                                              v10.0.0

                                                                              +

                                                                            • Adds the listener function to the end of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.

                                                                              @@ -372,8 +376,8 @@

                                                                              Parameters

                                                                              • event: "close"
                                                                              • listener: () => void

                                                                                The callback function

                                                                                -

                                                                              Returns this

                                                                              v0.1.101

                                                                              -

                                                                            • Parameters

                                                                              • event: "drain"
                                                                              • listener: () => void

                                                                              Returns this

                                                                            • Parameters

                                                                              • event: "error"
                                                                              • listener: (err: Error) => void

                                                                              Returns this

                                                                            • Parameters

                                                                              • event: "finish"
                                                                              • listener: () => void

                                                                              Returns this

                                                                            • Parameters

                                                                              • event: "pipe"
                                                                              • listener: (src: Readable) => void

                                                                              Returns this

                                                                            • Parameters

                                                                              • event: "unpipe"
                                                                              • listener: (src: Readable) => void

                                                                              Returns this

                                                                            • Parameters

                                                                              • event: string | symbol
                                                                              • listener: (...args: any[]) => void

                                                                              Returns this

                                                                            • Adds a one-time listener function for the event named eventName. The +

                                                                            Returns this

                                                                            v0.1.101

                                                                            +

                                                                          • Parameters

                                                                            • event: "drain"
                                                                            • listener: () => void

                                                                            Returns this

                                                                          • Parameters

                                                                            • event: "error"
                                                                            • listener: (err: Error) => void

                                                                            Returns this

                                                                          • Parameters

                                                                            • event: "finish"
                                                                            • listener: () => void

                                                                            Returns this

                                                                          • Parameters

                                                                            • event: "pipe"
                                                                            • listener: (src: Readable) => void

                                                                            Returns this

                                                                          • Parameters

                                                                            • event: "unpipe"
                                                                            • listener: (src: Readable) => void

                                                                            Returns this

                                                                          • Parameters

                                                                            • event: string | symbol
                                                                            • listener: (...args: any[]) => void

                                                                            Returns this

                                                                            • Adds a one-time listener function for the event named eventName. The next time eventName is triggered, this listener is removed and then invoked.

                                                                              server.once('connection', (stream) => {
                                                                                console.log('Ah, we have our first user!');
                                                                              });
                                                                              @@ -385,8 +389,8 @@

                                                                              Parameters

                                                                              • event: "close"
                                                                              • listener: () => void

                                                                                The callback function

                                                                                -

                                                                              Returns this

                                                                              v0.3.0

                                                                              -

                                                                            • Parameters

                                                                              • event: "drain"
                                                                              • listener: () => void

                                                                              Returns this

                                                                            • Parameters

                                                                              • event: "error"
                                                                              • listener: (err: Error) => void

                                                                              Returns this

                                                                            • Parameters

                                                                              • event: "finish"
                                                                              • listener: () => void

                                                                              Returns this

                                                                            • Parameters

                                                                              • event: "pipe"
                                                                              • listener: (src: Readable) => void

                                                                              Returns this

                                                                            • Parameters

                                                                              • event: "unpipe"
                                                                              • listener: (src: Readable) => void

                                                                              Returns this

                                                                            • Parameters

                                                                              • event: string | symbol
                                                                              • listener: (...args: any[]) => void

                                                                              Returns this

                                                                            • Type Parameters

                                                                              Parameters

                                                                              • destination: T
                                                                              • Optionaloptions: { end?: boolean }

                                                                              Returns T

                                                                            • Adds the listener function to the beginning of the listeners array for the +

                                                                            Returns this

                                                                            v0.3.0

                                                                            +

                                                                          • Parameters

                                                                            • event: "drain"
                                                                            • listener: () => void

                                                                            Returns this

                                                                          • Parameters

                                                                            • event: "error"
                                                                            • listener: (err: Error) => void

                                                                            Returns this

                                                                          • Parameters

                                                                            • event: "finish"
                                                                            • listener: () => void

                                                                            Returns this

                                                                          • Parameters

                                                                            • event: "pipe"
                                                                            • listener: (src: Readable) => void

                                                                            Returns this

                                                                          • Parameters

                                                                            • event: "unpipe"
                                                                            • listener: (src: Readable) => void

                                                                            Returns this

                                                                          • Parameters

                                                                            • event: string | symbol
                                                                            • listener: (...args: any[]) => void

                                                                            Returns this

                                                                            • Type Parameters

                                                                              Parameters

                                                                              • destination: T
                                                                              • Optionaloptions: { end?: boolean }

                                                                              Returns T

                                                                            • Adds the listener function to the beginning of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.

                                                                              @@ -395,34 +399,34 @@

                                                                              Returns a reference to the EventEmitter, so that calls can be chained.

                                                                              Parameters

                                                                              • event: "close"
                                                                              • listener: () => void

                                                                                The callback function

                                                                                -

                                                                              Returns this

                                                                              v6.0.0

                                                                              -

                                                                            • Parameters

                                                                              • event: "drain"
                                                                              • listener: () => void

                                                                              Returns this

                                                                            • Parameters

                                                                              • event: "error"
                                                                              • listener: (err: Error) => void

                                                                              Returns this

                                                                            • Parameters

                                                                              • event: "finish"
                                                                              • listener: () => void

                                                                              Returns this

                                                                            • Parameters

                                                                              • event: "pipe"
                                                                              • listener: (src: Readable) => void

                                                                              Returns this

                                                                            • Parameters

                                                                              • event: "unpipe"
                                                                              • listener: (src: Readable) => void

                                                                              Returns this

                                                                            • Parameters

                                                                              • event: string | symbol
                                                                              • listener: (...args: any[]) => void

                                                                              Returns this

                                                                            • Adds a one-timelistener function for the event named eventName to the beginning of the listeners array. The next time eventName is triggered, this +

                                                                            Returns this

                                                                            v6.0.0

                                                                            +

                                                                          • Parameters

                                                                            • event: "drain"
                                                                            • listener: () => void

                                                                            Returns this

                                                                          • Parameters

                                                                            • event: "error"
                                                                            • listener: (err: Error) => void

                                                                            Returns this

                                                                          • Parameters

                                                                            • event: "finish"
                                                                            • listener: () => void

                                                                            Returns this

                                                                          • Parameters

                                                                            • event: "pipe"
                                                                            • listener: (src: Readable) => void

                                                                            Returns this

                                                                          • Parameters

                                                                            • event: "unpipe"
                                                                            • listener: (src: Readable) => void

                                                                            Returns this

                                                                          • Parameters

                                                                            • event: string | symbol
                                                                            • listener: (...args: any[]) => void

                                                                            Returns this

                                                                            • Adds a one-timelistener function for the event named eventName to the beginning of the listeners array. The next time eventName is triggered, this listener is removed, and then invoked.

                                                                              server.prependOnceListener('connection', (stream) => {
                                                                                console.log('Ah, we have our first user!');
                                                                              });

                                                                              Returns a reference to the EventEmitter, so that calls can be chained.

                                                                              Parameters

                                                                              • event: "close"
                                                                              • listener: () => void

                                                                                The callback function

                                                                                -

                                                                              Returns this

                                                                              v6.0.0

                                                                              -

                                                                            • Parameters

                                                                              • event: "drain"
                                                                              • listener: () => void

                                                                              Returns this

                                                                            • Parameters

                                                                              • event: "error"
                                                                              • listener: (err: Error) => void

                                                                              Returns this

                                                                            • Parameters

                                                                              • event: "finish"
                                                                              • listener: () => void

                                                                              Returns this

                                                                            • Parameters

                                                                              • event: "pipe"
                                                                              • listener: (src: Readable) => void

                                                                              Returns this

                                                                            • Parameters

                                                                              • event: "unpipe"
                                                                              • listener: (src: Readable) => void

                                                                              Returns this

                                                                            • Parameters

                                                                              • event: string | symbol
                                                                              • listener: (...args: any[]) => void

                                                                              Returns this

                                                                            • Returns a copy of the array of listeners for the event named eventName, +

                                                                            Returns this

                                                                            v6.0.0

                                                                            +

                                                                          • Parameters

                                                                            • event: "drain"
                                                                            • listener: () => void

                                                                            Returns this

                                                                          • Parameters

                                                                            • event: "error"
                                                                            • listener: (err: Error) => void

                                                                            Returns this

                                                                          • Parameters

                                                                            • event: "finish"
                                                                            • listener: () => void

                                                                            Returns this

                                                                          • Parameters

                                                                            • event: "pipe"
                                                                            • listener: (src: Readable) => void

                                                                            Returns this

                                                                          • Parameters

                                                                            • event: "unpipe"
                                                                            • listener: (src: Readable) => void

                                                                            Returns this

                                                                          • Parameters

                                                                            • event: string | symbol
                                                                            • listener: (...args: any[]) => void

                                                                            Returns this

                                                                            • Returns a copy of the array of listeners for the event named eventName, including any wrappers (such as those created by .once()).

                                                                              import { EventEmitter } from 'node:events';
                                                                              const emitter = new EventEmitter();
                                                                              emitter.once('log', () => console.log('log once'));

                                                                              // Returns a new Array with a function `onceWrapper` which has a property
                                                                              // `listener` which contains the original listener bound above
                                                                              const listeners = emitter.rawListeners('log');
                                                                              const logFnWrapper = listeners[0];

                                                                              // Logs "log once" to the console and does not unbind the `once` event
                                                                              logFnWrapper.listener();

                                                                              // Logs "log once" to the console and removes the listener
                                                                              logFnWrapper();

                                                                              emitter.on('log', () => console.log('log persistently'));
                                                                              // Will return a new Array with a single function bound by `.on()` above
                                                                              const newListeners = emitter.rawListeners('log');

                                                                              // Logs "log persistently" twice
                                                                              newListeners[0]();
                                                                              emitter.emit('log');
                                                                              -

                                                                              Type Parameters

                                                                              • K

                                                                              Parameters

                                                                              • eventName: string | symbol

                                                                              Returns Function[]

                                                                              v9.4.0

                                                                              -

                                                                            • Removes all listeners, or those of the specified eventName.

                                                                              +

                                                                              Type Parameters

                                                                              • K

                                                                              Parameters

                                                                              • eventName: string | symbol

                                                                              Returns Function[]

                                                                              v9.4.0

                                                                              +

                                                                            • Removes all listeners, or those of the specified eventName.

                                                                              It is bad practice to remove listeners added elsewhere in the code, particularly when the EventEmitter instance was created by some other component or module (e.g. sockets or file streams).

                                                                              Returns a reference to the EventEmitter, so that calls can be chained.

                                                                              -

                                                                              Parameters

                                                                              • OptionaleventName: string | symbol

                                                                              Returns this

                                                                              v0.1.26

                                                                              -

                                                                            • Removes a header that is queued for implicit sending.

                                                                              +

                                                                              Parameters

                                                                              • OptionaleventName: string | symbol

                                                                              Returns this

                                                                              v0.1.26

                                                                              +

                                                                            • Removes a header that is queued for implicit sending.

                                                                              outgoingMessage.removeHeader('Content-Encoding');

                                                                              Parameters

                                                                              • name: string

                                                                                Header name

                                                                                -

                                                                              Returns void

                                                                              v0.4.0

                                                                              -

                                                                            • Removes the specified listener from the listener array for the event named eventName.

                                                                              +

                                                                            Returns void

                                                                            v0.4.0

                                                                            +

                                                                            • Removes the specified listener from the listener array for the event named eventName.

                                                                              const callback = (stream) => {
                                                                                console.log('someone connected!');
                                                                              };
                                                                              server.on('connection', callback);
                                                                              // ...
                                                                              server.removeListener('connection', callback);
                                                                              @@ -448,17 +452,17 @@

                                                                              Returns a reference to the EventEmitter, so that calls can be chained.

                                                                              -

                                                                              Parameters

                                                                              • event: "close"
                                                                              • listener: () => void

                                                                              Returns this

                                                                              v0.1.26

                                                                              -

                                                                            • Parameters

                                                                              • event: "drain"
                                                                              • listener: () => void

                                                                              Returns this

                                                                            • Parameters

                                                                              • event: "error"
                                                                              • listener: (err: Error) => void

                                                                              Returns this

                                                                            • Parameters

                                                                              • event: "finish"
                                                                              • listener: () => void

                                                                              Returns this

                                                                            • Parameters

                                                                              • event: "pipe"
                                                                              • listener: (src: Readable) => void

                                                                              Returns this

                                                                            • Parameters

                                                                              • event: "unpipe"
                                                                              • listener: (src: Readable) => void

                                                                              Returns this

                                                                            • Parameters

                                                                              • event: string | symbol
                                                                              • listener: (...args: any[]) => void

                                                                              Returns this

                                                                            • The writable.setDefaultEncoding() method sets the default encoding for a Writable stream.

                                                                              +

                                                                              Parameters

                                                                              • event: "close"
                                                                              • listener: () => void

                                                                              Returns this

                                                                              v0.1.26

                                                                              +

                                                                            • Parameters

                                                                              • event: "drain"
                                                                              • listener: () => void

                                                                              Returns this

                                                                            • Parameters

                                                                              • event: "error"
                                                                              • listener: (err: Error) => void

                                                                              Returns this

                                                                            • Parameters

                                                                              • event: "finish"
                                                                              • listener: () => void

                                                                              Returns this

                                                                            • Parameters

                                                                              • event: "pipe"
                                                                              • listener: (src: Readable) => void

                                                                              Returns this

                                                                            • Parameters

                                                                              • event: "unpipe"
                                                                              • listener: (src: Readable) => void

                                                                              Returns this

                                                                            • Parameters

                                                                              • event: string | symbol
                                                                              • listener: (...args: any[]) => void

                                                                              Returns this

                                                                            • The writable.setDefaultEncoding() method sets the default encoding for a Writable stream.

                                                                              Parameters

                                                                              Returns this

                                                                              v0.11.15

                                                                              -

                                                                            • Sets a single header value. If the header already exists in the to-be-sent +

                                                                            Returns this

                                                                            v0.11.15

                                                                            +

                                                                            • Sets a single header value. If the header already exists in the to-be-sent headers, its value will be replaced. Use an array of strings to send multiple headers with the same name.

                                                                              Parameters

                                                                              • name: string

                                                                                Header name

                                                                                -
                                                                              • value: string | number | readonly string[]

                                                                                Header value

                                                                                -

                                                                              Returns this

                                                                              v0.4.0

                                                                              -

                                                                            • Sets multiple header values for implicit headers. headers must be an instance of +

                                                                            • value: string | number | readonly string[]

                                                                              Header value

                                                                              +

                                                                            Returns this

                                                                            v0.4.0

                                                                            +

                                                                            • Sets multiple header values for implicit headers. headers must be an instance of Headers or Map, if a header already exists in the to-be-sent headers, its value will be replaced.

                                                                              const headers = new Headers({ foo: 'bar' });
                                                                              outgoingMessage.setHeaders(headers);
@@ -474,17 +478,17 @@
 
                                                                              // Returns content-type = text/plain
                                                                              const server = http.createServer((req, res) => {
                                                                                const headers = new Headers({ 'Content-Type': 'text/html' });
                                                                                res.setHeaders(headers);
                                                                                res.writeHead(200, { 'Content-Type': 'text/plain' });
                                                                                res.end('ok');
                                                                              });
 
                                                                              
 
-

                                                                              Parameters

                                                                              • headers: Headers | Map<string, string | number | readonly string[]>

                                                                              Returns this

                                                                              v19.6.0, v18.15.0

                                                                              -

                                                                            • By default EventEmitters will print a warning if more than 10 listeners are +

                                                                              Parameters

                                                                              • headers: Headers | Map<string, string | number | readonly string[]>

                                                                              Returns this

                                                                              v19.6.0, v18.15.0

                                                                              +

                                                                            • By default EventEmitters will print a warning if more than 10 listeners are added for a particular event. This is a useful default that helps finding memory leaks. The emitter.setMaxListeners() method allows the limit to be modified for this specific EventEmitter instance. The value can be set to Infinity (or 0) to indicate an unlimited number of listeners.

                                                                              Returns a reference to the EventEmitter, so that calls can be chained.

                                                                              -

                                                                              Parameters

                                                                              • n: number

                                                                              Returns this

                                                                              v0.3.5

                                                                              -

                                                                            • Once a socket is associated with the message and is connected, socket.setTimeout() will be called with msecs as the first parameter.

                                                                              +

                                                                              Parameters

                                                                              • n: number

                                                                              Returns this

                                                                              v0.3.5

                                                                              +

                                                                            • Once a socket is associated with the message and is connected, socket.setTimeout() will be called with msecs as the first parameter.

                                                                              Parameters

                                                                              • msecs: number
                                                                              • Optionalcallback: () => void

                                                                                Optional function to be called when a timeout occurs. Same as binding to the timeout event.

                                                                                -

                                                                              Returns this

                                                                              v0.9.12

                                                                              -

                                                                            • The writable.uncork() method flushes all data buffered since cork was called.

                                                                              +

                                                                            Returns this

                                                                            v0.9.12

                                                                            +

                                                                            • The writable.uncork() method flushes all data buffered since cork was called.

                                                                              When using writable.cork() and writable.uncork() to manage the buffering of writes to a stream, defer calls to writable.uncork() using process.nextTick(). Doing so allows batching of all writable.write() calls that occur within a given Node.js event loop phase.

                                                                              @@ -498,8 +502,8 @@

                                                                              See also: writable.cork().

                                                                              -

                                                                              Returns void

                                                                              v0.11.2

                                                                              -

                                                                            • The writable.write() method writes some data to the stream, and calls the +

                                                                              Returns void

                                                                              v0.11.2

                                                                              +

                                                                            • The writable.write() method writes some data to the stream, and calls the supplied callback once the data has been fully handled. If an error occurs, the callback will be called with the error as its first argument. The callback is called asynchronously and before 'error' is @@ -532,10 +536,10 @@

                                                                              A Writable stream in object mode will always ignore the encoding argument.

                                                                              Parameters

                                                                              • chunk: any

                                                                                Optional data to write. For streams not operating in object mode, chunk must be a {string}, {Buffer}, {TypedArray} or {DataView}. For object mode streams, chunk may be any JavaScript value other than null.

                                                                                -
                                                                              • Optionalcallback: (error: Error) => void

                                                                                Callback for when this chunk of data is flushed.

                                                                                -

                                                                              Returns boolean

                                                                              false if the stream wishes for the calling code to wait for the 'drain' event to be emitted before continuing to write additional data; otherwise true.

                                                                              -

                                                                              v0.9.4

                                                                              -

                                                                            • The writable.write() method writes some data to the stream, and calls the +

                                                                            • Optionalcallback: (error: Error) => void

                                                                              Callback for when this chunk of data is flushed.

                                                                              +

                                                                            Returns boolean

                                                                            false if the stream wishes for the calling code to wait for the 'drain' event to be emitted before continuing to write additional data; otherwise true.

                                                                            +

                                                                            v0.9.4

                                                                            +

                                                                          • The writable.write() method writes some data to the stream, and calls the supplied callback once the data has been fully handled. If an error occurs, the callback will be called with the error as its first argument. The callback is called asynchronously and before 'error' is @@ -568,11 +572,11 @@

                                                                            A Writable stream in object mode will always ignore the encoding argument.

                                                                            Parameters

                                                                            • chunk: any

                                                                              Optional data to write. For streams not operating in object mode, chunk must be a {string}, {Buffer}, {TypedArray} or {DataView}. For object mode streams, chunk may be any JavaScript value other than null.

                                                                              -
                                                                            • encoding: BufferEncoding

                                                                              The encoding, if chunk is a string.

                                                                              -
                                                                            • Optionalcallback: (error: Error) => void

                                                                              Callback for when this chunk of data is flushed.

                                                                              -

                                                                            Returns boolean

                                                                            false if the stream wishes for the calling code to wait for the 'drain' event to be emitted before continuing to write additional data; otherwise true.

                                                                            -

                                                                            v0.9.4

                                                                            -

                                                                            • Listens once to the abort event on the provided signal.

                                                                              +
                                                                            • encoding: BufferEncoding

                                                                              The encoding, if chunk is a string.

                                                                              +
                                                                            • Optionalcallback: (error: Error) => void

                                                                              Callback for when this chunk of data is flushed.

                                                                              +

                                                                            Returns boolean

                                                                            false if the stream wishes for the calling code to wait for the 'drain' event to be emitted before continuing to write additional data; otherwise true.

                                                                            +

                                                                            v0.9.4

                                                                            +

                                                                            • Listens once to the abort event on the provided signal.

                                                                              Listening to the abort event on abort signals is unsafe and may lead to resource leaks since another third party with the signal can call e.stopImmediatePropagation(). Unfortunately Node.js cannot change @@ -586,10 +590,10 @@

                                                                              Parameters

                                                                              Returns Disposable

                                                                              Disposable that removes the abort listener.

                                                                              -

                                                                              v20.5.0

                                                                              -

                                                                            • A utility method for creating a Writable from a web WritableStream.

                                                                              -

                                                                              Parameters

                                                                              • writableStream: WritableStream
                                                                              • Optionaloptions: Pick<
                                                                                    WritableOptions,
                                                                                    "decodeStrings"
                                                                                    | "highWaterMark"
                                                                                    | "objectMode"
                                                                                    | "signal",
                                                                                >

                                                                              Returns Writable

                                                                              v17.0.0

                                                                              -

                                                                            • Returns a copy of the array of listeners for the event named eventName.

                                                                              +

                                                                              v20.5.0

                                                                              +

                                                                            • A utility method for creating a Writable from a web WritableStream.

                                                                              +

                                                                              Parameters

                                                                              • writableStream: WritableStream
                                                                              • Optionaloptions: Pick<
                                                                                    WritableOptions,
                                                                                    "decodeStrings"
                                                                                    | "highWaterMark"
                                                                                    | "objectMode"
                                                                                    | "signal",
                                                                                >

                                                                              Returns Writable

                                                                              v17.0.0

                                                                              +

                                                                            • Returns a copy of the array of listeners for the event named eventName.

                                                                              For EventEmitters this behaves exactly the same as calling .listeners on the emitter.

                                                                              For EventTargets this is the only way to get the event listeners for the @@ -597,8 +601,8 @@ 

                                                                              import { getEventListeners, EventEmitter } from 'node:events';

                                                                              {
                                                                                const ee = new EventEmitter();
                                                                                const listener = () => console.log('Events are fun');
                                                                                ee.on('foo', listener);
                                                                                console.log(getEventListeners(ee, 'foo')); // [ [Function: listener] ]
                                                                              }
                                                                              {
                                                                                const et = new EventTarget();
                                                                                const listener = () => console.log('Events are fun');
                                                                                et.addEventListener('foo', listener);
                                                                                console.log(getEventListeners(et, 'foo')); // [ [Function: listener] ]
                                                                              }
                                                                              -

                                                                              Parameters

                                                                              Returns Function[]

                                                                              v15.2.0, v14.17.0

                                                                              -

                                                                            • Returns the currently set max amount of listeners.

                                                                              For EventEmitters this behaves exactly the same as calling .getMaxListeners on the emitter.

                                                                              For EventTargets this is the only way to get the max event listeners for the @@ -607,16 +611,16 @@ 

                                                                              import { getMaxListeners, setMaxListeners, EventEmitter } from 'node:events';

                                                                              {
                                                                                const ee = new EventEmitter();
                                                                                console.log(getMaxListeners(ee)); // 10
                                                                                setMaxListeners(11, ee);
                                                                                console.log(getMaxListeners(ee)); // 11
                                                                              }
                                                                              {
                                                                                const et = new EventTarget();
                                                                                console.log(getMaxListeners(et)); // 10
                                                                                setMaxListeners(11, et);
                                                                                console.log(getMaxListeners(et)); // 11
                                                                              }
                                                                              -

                                                                              Parameters

                                                                              Returns number

                                                                              v19.9.0

                                                                              -

                                                                            • A class method that returns the number of listeners for the given eventName registered on the given emitter.

                                                                              import { EventEmitter, listenerCount } from 'node:events';

                                                                              const myEmitter = new EventEmitter();
                                                                              myEmitter.on('event', () => {});
                                                                              myEmitter.on('event', () => {});
                                                                              console.log(listenerCount(myEmitter, 'event'));
                                                                              // Prints: 2

                                                                              Parameters

                                                                              • emitter: EventEmitter

                                                                                The emitter to query

                                                                                -
                                                                              • eventName: string | symbol

                                                                                The event name

                                                                                -

                                                                              Returns number

                                                                              v0.9.12

                                                                              +
                                                                            • eventName: string | symbol

                                                                              The event name

                                                                              +

                                                                            Returns number

                                                                            v0.9.12

                                                                            Since v3.2.0 - Use listenerCount instead.

                                                                            -
                                                                            • import { on, EventEmitter } from 'node:events';
                                                                              import process from 'node:process';

                                                                              const ee = new EventEmitter();

                                                                              // Emit later on
                                                                              process.nextTick(() => {
                                                                                ee.emit('foo', 'bar');
                                                                                ee.emit('foo', 42);
                                                                              });

                                                                              for await (const event of on(ee, 'foo')) {
                                                                                // The execution of this inner block is synchronous and it
                                                                                // processes one event at a time (even with await). Do not use
                                                                                // if concurrent execution is required.
                                                                                console.log(event); // prints ['bar'] [42]
                                                                              }
                                                                              // Unreachable here
+
                                                                            • import { on, EventEmitter } from 'node:events';
                                                                              import process from 'node:process';

                                                                              const ee = new EventEmitter();

                                                                              // Emit later on
                                                                              process.nextTick(() => {
                                                                                ee.emit('foo', 'bar');
                                                                                ee.emit('foo', 42);
                                                                              });

                                                                              for await (const event of on(ee, 'foo')) {
                                                                                // The execution of this inner block is synchronous and it
                                                                                // processes one event at a time (even with await). Do not use
                                                                                // if concurrent execution is required.
                                                                                console.log(event); // prints ['bar'] [42]
                                                                              }
                                                                              // Unreachable here

                                                                              Returns an AsyncIterator that iterates eventName events. It will throw @@ -632,8 +636,8 @@

                                                                              Parameters

                                                                              Returns AsyncIterator<any[]>

                                                                              An AsyncIterator that iterates eventName events emitted by the emitter

                                                                              -

                                                                              v13.6.0, v12.16.0

                                                                              -
                                                                            • import { on, EventEmitter } from 'node:events';
                                                                              import process from 'node:process';

                                                                              const ee = new EventEmitter();

                                                                              // Emit later on
                                                                              process.nextTick(() => {
                                                                                ee.emit('foo', 'bar');
                                                                                ee.emit('foo', 42);
                                                                              });

                                                                              for await (const event of on(ee, 'foo')) {
                                                                                // The execution of this inner block is synchronous and it
                                                                                // processes one event at a time (even with await). Do not use
                                                                                // if concurrent execution is required.
                                                                                console.log(event); // prints ['bar'] [42]
                                                                              }
                                                                              // Unreachable here
+
                                                                              v13.6.0, v12.16.0
                                                                              
+
                                                                            • import { on, EventEmitter } from 'node:events';
                                                                              import process from 'node:process';

                                                                              const ee = new EventEmitter();

                                                                              // Emit later on
                                                                              process.nextTick(() => {
                                                                                ee.emit('foo', 'bar');
                                                                                ee.emit('foo', 42);
                                                                              });

                                                                              for await (const event of on(ee, 'foo')) {
                                                                                // The execution of this inner block is synchronous and it
                                                                                // processes one event at a time (even with await). Do not use
                                                                                // if concurrent execution is required.
                                                                                console.log(event); // prints ['bar'] [42]
                                                                              }
                                                                              // Unreachable here

                                                                              Returns an AsyncIterator that iterates eventName events. It will throw @@ -649,8 +653,8 @@

                                                                              Parameters

                                                                              Returns AsyncIterator<any[]>

                                                                              An AsyncIterator that iterates eventName events emitted by the emitter

                                                                              -

                                                                              v13.6.0, v12.16.0

                                                                              -

                                                                            • Creates a Promise that is fulfilled when the EventEmitter emits the given +

                                                                              v13.6.0, v12.16.0

                                                                              +

                                                                            • Creates a Promise that is fulfilled when the EventEmitter emits the given event or that is rejected if the EventEmitter emits 'error' while waiting. The Promise will resolve with an array of all the arguments emitted to the given event.

                                                                              @@ -669,8 +673,8 @@ 
                                                                              import { EventEmitter, once } from 'node:events';

                                                                              const ee = new EventEmitter();
                                                                              const ac = new AbortController();

                                                                              async function foo(emitter, event, signal) {
                                                                                try {
                                                                                  await once(emitter, event, { signal });
                                                                                  console.log('event emitted!');
                                                                                } catch (error) {
                                                                                  if (error.name === 'AbortError') {
                                                                                    console.error('Waiting for the event was canceled!');
                                                                                  } else {
                                                                                    console.error('There was an error', error.message);
                                                                                  }
                                                                                }
                                                                              }

                                                                              foo(ee, 'foo', ac.signal);
                                                                              ac.abort(); // Abort waiting for the event
                                                                              ee.emit('foo'); // Prints: Waiting for the event was canceled!
                                                                              -

                                                                              Parameters

                                                                              Returns Promise<any[]>

                                                                              v11.13.0, v10.16.0

                                                                              -

                                                                            • Creates a Promise that is fulfilled when the EventEmitter emits the given +

                                                                              Parameters

                                                                              Returns Promise<any[]>

                                                                              v11.13.0, v10.16.0

                                                                              +

                                                                            • Creates a Promise that is fulfilled when the EventEmitter emits the given event or that is rejected if the EventEmitter emits 'error' while waiting. The Promise will resolve with an array of all the arguments emitted to the given event.

                                                                              @@ -689,14 +693,14 @@ 
                                                                              import { EventEmitter, once } from 'node:events';

                                                                              const ee = new EventEmitter();
                                                                              const ac = new AbortController();

                                                                              async function foo(emitter, event, signal) {
                                                                                try {
                                                                                  await once(emitter, event, { signal });
                                                                                  console.log('event emitted!');
                                                                                } catch (error) {
                                                                                  if (error.name === 'AbortError') {
                                                                                    console.error('Waiting for the event was canceled!');
                                                                                  } else {
                                                                                    console.error('There was an error', error.message);
                                                                                  }
                                                                                }
                                                                              }

                                                                              foo(ee, 'foo', ac.signal);
                                                                              ac.abort(); // Abort waiting for the event
                                                                              ee.emit('foo'); // Prints: Waiting for the event was canceled!
                                                                              -

                                                                              Parameters

                                                                              Returns Promise<any[]>

                                                                              v11.13.0, v10.16.0

                                                                              -
                                                                            • import { setMaxListeners, EventEmitter } from 'node:events';

                                                                              const target = new EventTarget();
                                                                              const emitter = new EventEmitter();

                                                                              setMaxListeners(5, target, emitter);
+

                                                                              Parameters

                                                                              Returns Promise<any[]>

                                                                              v11.13.0, v10.16.0

                                                                              +
                                                                            • import { setMaxListeners, EventEmitter } from 'node:events';

                                                                              const target = new EventTarget();
                                                                              const emitter = new EventEmitter();

                                                                              setMaxListeners(5, target, emitter);

                                                                              Parameters

                                                                              • Optionaln: number

                                                                                A non-negative number. The maximum number of listeners per EventTarget event.

                                                                                -
                                                                              • ...eventTargets: (EventEmitter<DefaultEventMap> | EventTarget)[]

                                                                                Zero or more {EventTarget} or {EventEmitter} instances. If none are specified, n is set as the default max for all newly created {EventTarget} and {EventEmitter} +

                                                                              • ...eventTargets: (EventEmitter<DefaultEventMap> | EventTarget)[]

                                                                                Zero or more {EventTarget} or {EventEmitter} instances. If none are specified, n is set as the default max for all newly created {EventTarget} and {EventEmitter} objects.

                                                                                -

                                                                              Returns void

                                                                              v15.4.0

                                                                              -

                                                                            Settings

                                                                            Member Visibility

                                                                            On This Page

                                                                            Constructors
                                                                            Properties
                                                                            Methods
                                                                            +

                                                                            Returns void

                                                                            v15.4.0

                                                                            +

                                                                            Settings

                                                                            Member Visibility

                                                                            On This Page

                                                                            Constructors
                                                                            Properties
                                                                            Methods
                                                                            diff --git a/docs/classes/_internal_.Pair.html b/docs/classes/_internal_.Pair.html index c54ca385..7857599a 100644 --- a/docs/classes/_internal_.Pair.html +++ b/docs/classes/_internal_.Pair.html @@ -6,7 +6,7 @@

                                                                            Methods

                                                                            clone toJSON toString -

                                                                            Constructors

                                                                            • Type Parameters

                                                                              • K = unknown
                                                                              • V = unknown

                                                                              Parameters

                                                                              • key: K
                                                                              • Optionalvalue: V

                                                                              Returns Pair<K, V>

                                                                            Properties

                                                                            "[NODE_TYPE]": symbol
                                                                            key: K

                                                                            Always Node or null when parsed, but can be set to anything.

                                                                            -
                                                                            srcToken?: CollectionItem

                                                                            The CST token that was composed into this pair.

                                                                            -
                                                                            value: V

                                                                            Always Node or null when parsed, but can be set to anything.

                                                                            -

                                                                            Methods

                                                                            • Parameters

                                                                              Returns Pair<K, V>

                                                                            • Parameters

                                                                              • Optionalctx: StringifyContext
                                                                              • OptionalonComment: () => void
                                                                              • OptionalonChompKeep: () => void

                                                                              Returns string

                                                                            Settings

                                                                            Member Visibility

                                                                            On This Page

                                                                            Constructors
                                                                            Properties
                                                                            Methods
                                                                            +

                                                                            Constructors

                                                                            • Type Parameters

                                                                              • K = unknown
                                                                              • V = unknown

                                                                              Parameters

                                                                              • key: K
                                                                              • Optionalvalue: V

                                                                              Returns Pair<K, V>

                                                                            Properties

                                                                            "[NODE_TYPE]": symbol
                                                                            key: K

                                                                            Always Node or null when parsed, but can be set to anything.

                                                                            +
                                                                            srcToken?: CollectionItem

                                                                            The CST token that was composed into this pair.

                                                                            +
                                                                            value: V

                                                                            Always Node or null when parsed, but can be set to anything.

                                                                            +

                                                                            Methods

                                                                            • Parameters

                                                                              Returns Pair<K, V>

                                                                            • Parameters

                                                                              • Optionalctx: StringifyContext
                                                                              • OptionalonComment: () => void
                                                                              • OptionalonChompKeep: () => void

                                                                              Returns string

                                                                            Settings

                                                                            Member Visibility

                                                                            On This Page

                                                                            Constructors
                                                                            Properties
                                                                            Methods
                                                                            diff --git a/docs/classes/_internal_.Readable.html b/docs/classes/_internal_.Readable.html index 23153602..5bd35115 100644 --- a/docs/classes/_internal_.Readable.html +++ b/docs/classes/_internal_.Readable.html @@ -1,5 +1,5 @@ Readable | ts-lambda-api - v2.5.2
                                                                            ts-lambda-api - v2.5.2
                                                                              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 @@ -104,10 +104,10 @@
                                                                              captureRejections: boolean

                                                                              Value: boolean

                                                                              Change the default captureRejections option on all new EventEmitter objects.

                                                                              v13.4.0, v12.16.0

                                                                              -
                                                                              captureRejectionSymbol: typeof captureRejectionSymbol

                                                                              Value: Symbol.for('nodejs.rejection')

                                                                              +
                                                                              captureRejectionSymbol: typeof captureRejectionSymbol

                                                                              Value: Symbol.for('nodejs.rejection')

                                                                              See how to write a custom rejection handler.

                                                                              v13.4.0, v12.16.0

                                                                              -
                                                                              defaultMaxListeners: number

                                                                              By default, a maximum of 10 listeners can be registered for any single +

                                                                              defaultMaxListeners: number

                                                                              By default, a maximum of 10 listeners can be registered for any single event. This limit can be changed for individual EventEmitter instances using the emitter.setMaxListeners(n) method. To change the default for allEventEmitter instances, the events.defaultMaxListeners property @@ -132,13 +132,16 @@ listeners, respectively. Its name property is set to 'MaxListenersExceededWarning'.

                                                                              v0.11.2

                                                                              -
                                                                              errorMonitor: typeof errorMonitor

                                                                              This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

                                                                              +
                                                                              errorMonitor: typeof errorMonitor

                                                                              This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

                                                                              Installing a listener using this symbol does not change the behavior once an 'error' event is emitted. Therefore, the process will still crash if no regular 'error' listener is installed.

                                                                              v13.6.0, v12.17.0

                                                                              -

                                                                              Methods

                                                                              Optional_construct

                                                                              • _construct(callback: (error?: Error) => void): void

                                                                                Parameters

                                                                                • callback: (error?: Error) => void

                                                                                Returns void

                                                                              _destroy

                                                                              • _destroy(error: Error, callback: (error?: Error) => void): void

                                                                                Parameters

                                                                                • error: Error
                                                                                • callback: (error?: Error) => void

                                                                                Returns void

                                                                              _read

                                                                              • _read(size: number): void

                                                                                Parameters

                                                                                • size: number

                                                                                Returns void

                                                                              • Calls readable.destroy() with an AbortError and returns a promise that fulfills when the stream is finished.

                                                                                +

                                                                              Methods

                                                                              Optional_construct

                                                                              • _construct?(callback: (error?: Error) => void): void

                                                                                Parameters

                                                                                • callback: (error?: Error) => void

                                                                                Returns void

                                                                              _destroy

                                                                              • _destroy(error: Error, callback: (error?: Error) => void): void

                                                                                Parameters

                                                                                • error: Error
                                                                                • callback: (error?: Error) => void

                                                                                Returns void

                                                                              _read

                                                                              • _read(size: number): void

                                                                                Parameters

                                                                                • size: number

                                                                                Returns void

                                                                              • Calls readable.destroy() with an AbortError and returns +a promise that fulfills when the stream is finished.

                                                                                Returns Promise<void>

                                                                                v20.4.0

                                                                                -

                                                                              • Returns AsyncIterator<any>

                                                                              • Event emitter +

                                                                              • Returns AsyncIterator<any>

                                                                                AsyncIterator to fully consume the stream.

                                                                                +

                                                                                v10.0.0

                                                                                +

                                                                              • Event emitter The defined events on documents including:

                                                                                1. close
                                                                                  2. @@ -149,7 +152,7 @@
                                                                                2. readable
                                                                                3. resume
                                                                                -

                                                                                Parameters

                                                                                • event: "close"
                                                                                • listener: () => void

                                                                                Returns this

                                                                              • Event emitter +

                                                                                Parameters

                                                                                • event: "close"
                                                                                • listener: () => void

                                                                                Returns this

                                                                              • Event emitter The defined events on documents including:

                                                                                1. close
                                                                                  2. @@ -160,7 +163,7 @@
                                                                                2. readable
                                                                                3. resume
                                                                                -

                                                                                Parameters

                                                                                • event: "data"
                                                                                • listener: (chunk: any) => void

                                                                                Returns this

                                                                              • Event emitter +

                                                                                Parameters

                                                                                • event: "data"
                                                                                • listener: (chunk: any) => void

                                                                                Returns this

                                                                              • Event emitter The defined events on documents including:

                                                                                1. close
                                                                                  2. @@ -171,7 +174,7 @@
                                                                                2. readable
                                                                                3. resume
                                                                                -

                                                                                Parameters

                                                                                • event: "end"
                                                                                • listener: () => void

                                                                                Returns this

                                                                              • Event emitter +

                                                                                Parameters

                                                                                • event: "end"
                                                                                • listener: () => void

                                                                                Returns this

                                                                              • Event emitter The defined events on documents including:

                                                                                1. close
                                                                                  2. @@ -182,7 +185,7 @@
                                                                                2. readable
                                                                                3. resume
                                                                                -

                                                                                Parameters

                                                                                • event: "error"
                                                                                • listener: (err: Error) => void

                                                                                Returns this

                                                                              • Event emitter +

                                                                                Parameters

                                                                                • event: "error"
                                                                                • listener: (err: Error) => void

                                                                                Returns this

                                                                              • Event emitter The defined events on documents including:

                                                                                1. close
                                                                                  2. @@ -193,7 +196,7 @@
                                                                                2. readable
                                                                                3. resume
                                                                                -

                                                                                Parameters

                                                                                • event: "pause"
                                                                                • listener: () => void

                                                                                Returns this

                                                                              • Event emitter +

                                                                                Parameters

                                                                                • event: "pause"
                                                                                • listener: () => void

                                                                                Returns this

                                                                              • Event emitter The defined events on documents including:

                                                                                1. close
                                                                                  2. @@ -204,7 +207,7 @@
                                                                                2. readable
                                                                                3. resume
                                                                                -

                                                                                Parameters

                                                                                • event: "readable"
                                                                                • listener: () => void

                                                                                Returns this

                                                                              • Event emitter +

                                                                                Parameters

                                                                                • event: "readable"
                                                                                • listener: () => void

                                                                                Returns this

                                                                              • Event emitter The defined events on documents including:

                                                                                1. close
                                                                                  2. @@ -215,7 +218,7 @@
                                                                                2. readable
                                                                                3. resume
                                                                                -

                                                                                Parameters

                                                                                • event: "resume"
                                                                                • listener: () => void

                                                                                Returns this

                                                                              • Event emitter +

                                                                                Parameters

                                                                                • event: "resume"
                                                                                • listener: () => void

                                                                                Returns this

                                                                              • Event emitter The defined events on documents including:

                                                                                1. close
                                                                                  2. @@ -226,70 +229,70 @@
                                                                                2. readable
                                                                                3. resume
                                                                                -

                                                                                Parameters

                                                                                • event: string | symbol
                                                                                • listener: (...args: any[]) => void

                                                                                Returns this

                                                                              • This method returns a new stream with chunks of the underlying stream paired with a counter +

                                                                                Parameters

                                                                                • event: string | symbol
                                                                                • listener: (...args: any[]) => void

                                                                                Returns this

                                                                              • This method returns a new stream with chunks of the underlying stream paired with a counter in the form [index, chunk]. The first index value is 0 and it increases by 1 for each chunk produced.

                                                                                Parameters

                                                                                Returns Readable

                                                                                a stream of indexed pairs.

                                                                                -

                                                                                v17.5.0

                                                                                -

                                                                              • Destroy the stream. Optionally emit an 'error' event, and emit a 'close' event (unless emitClose is set to false). After this call, the readable +

                                                                                v17.5.0

                                                                                +

                                                                              • Destroy the stream. Optionally emit an 'error' event, and emit a 'close' event (unless emitClose is set to false). After this call, the readable stream will release any internal resources and subsequent calls to push() will be ignored.

                                                                                Once destroy() has been called any further calls will be a no-op and no further errors except from _destroy() may be emitted as 'error'.

                                                                                Implementors should not override this method, but instead implement readable._destroy().

                                                                                Parameters

                                                                                • Optionalerror: Error

                                                                                  Error which will be passed as payload in 'error' event

                                                                                  -

                                                                                Returns this

                                                                                v8.0.0

                                                                                +

                                                                              Returns this

                                                                              v8.0.0

                                                                              • This method returns a new stream with the first limit chunks dropped from the start.

                                                                                Parameters

                                                                                • limit: number

                                                                                  the number of chunks to drop from the readable.

                                                                                  -
                                                                                • Optionaloptions: Pick<Stream.ArrayOptions, "signal">

                                                                                Returns Readable

                                                                                a stream with limit chunks dropped from the start.

                                                                                -

                                                                                v17.5.0

                                                                                +
                                                                              • Optionaloptions: Pick<Stream.ArrayOptions, "signal">

                                                                              Returns Readable

                                                                              a stream with limit chunks dropped from the start.

                                                                              +

                                                                              v17.5.0

                                                                              • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

                                                                                Returns true if the event had listeners, false otherwise.

                                                                                import { EventEmitter } from 'node:events';
                                                                                const myEmitter = new EventEmitter();

                                                                                // First listener
                                                                                myEmitter.on('event', function firstListener() {
                                                                                  console.log('Helloooo! first listener');
                                                                                });
                                                                                // Second listener
                                                                                myEmitter.on('event', function secondListener(arg1, arg2) {
                                                                                  console.log(`event with parameters ${arg1}, ${arg2} in second listener`);
                                                                                });
                                                                                // Third listener
                                                                                myEmitter.on('event', function thirdListener(...args) {
                                                                                  const parameters = args.join(', ');
                                                                                  console.log(`event with parameters ${parameters} in third listener`);
                                                                                });

                                                                                console.log(myEmitter.listeners('event'));

                                                                                myEmitter.emit('event', 1, 2, 3, 4, 5);

                                                                                // Prints:
                                                                                // [
                                                                                //   [Function: firstListener],
                                                                                //   [Function: secondListener],
                                                                                //   [Function: thirdListener]
                                                                                // ]
                                                                                // Helloooo! first listener
                                                                                // event with parameters 1, 2 in second listener
                                                                                // event with parameters 1, 2, 3, 4, 5 in third listener
                                                                                -

                                                                                Parameters

                                                                                • event: "close"

                                                                                Returns boolean

                                                                                v0.1.26

                                                                                -

                                                                              • Parameters

                                                                                • event: "data"
                                                                                • chunk: any

                                                                                Returns boolean

                                                                              • Parameters

                                                                                • event: "end"

                                                                                Returns boolean

                                                                              • Parameters

                                                                                • event: "error"
                                                                                • err: Error

                                                                                Returns boolean

                                                                              • Parameters

                                                                                • event: "pause"

                                                                                Returns boolean

                                                                              • Parameters

                                                                                • event: "readable"

                                                                                Returns boolean

                                                                              • Parameters

                                                                                • event: "resume"

                                                                                Returns boolean

                                                                              • Parameters

                                                                                • event: string | symbol
                                                                                • ...args: any[]

                                                                                Returns boolean

                                                                              • Returns an array listing the events for which the emitter has registered +

                                                                                Parameters

                                                                                • event: "close"

                                                                                Returns boolean

                                                                                v0.1.26

                                                                                +

                                                                              • Parameters

                                                                                • event: "data"
                                                                                • chunk: any

                                                                                Returns boolean

                                                                              • Parameters

                                                                                • event: "end"

                                                                                Returns boolean

                                                                              • Parameters

                                                                                • event: "error"
                                                                                • err: Error

                                                                                Returns boolean

                                                                              • Parameters

                                                                                • event: "pause"

                                                                                Returns boolean

                                                                              • Parameters

                                                                                • event: "readable"

                                                                                Returns boolean

                                                                              • Parameters

                                                                                • event: "resume"

                                                                                Returns boolean

                                                                              • Parameters

                                                                                • event: string | symbol
                                                                                • ...args: any[]

                                                                                Returns boolean

                                                                              • Returns an array listing the events for which the emitter has registered listeners. The values in the array are strings or Symbols.

                                                                                import { EventEmitter } from 'node:events';

                                                                                const myEE = new EventEmitter();
                                                                                myEE.on('foo', () => {});
                                                                                myEE.on('bar', () => {});

                                                                                const sym = Symbol('symbol');
                                                                                myEE.on(sym, () => {});

                                                                                console.log(myEE.eventNames());
                                                                                // Prints: [ 'foo', 'bar', Symbol(symbol) ]
                                                                                -

                                                                                Returns (string | symbol)[]

                                                                                v6.0.0

                                                                                -

                                                                              • This method is similar to Array.prototype.every and calls fn on each chunk in the stream +

                                                                                Returns (string | symbol)[]

                                                                                v6.0.0

                                                                                +

                                                                              • This method is similar to Array.prototype.every and calls fn on each chunk in the stream to check if all awaited return values are truthy value for fn. Once an fn call on a chunk awaited return value is falsy, the stream is destroyed and the promise is fulfilled with false. If all of the fn calls on the chunks return a truthy value, the promise is fulfilled with true.

                                                                                Parameters

                                                                                • fn: (
                                                                                      data: any,
                                                                                      options?: Pick<Stream.ArrayOptions, "signal">,
                                                                                  ) => boolean | Promise<boolean>

                                                                                  a function to call on each chunk of the stream. Async or not.

                                                                                  -
                                                                                • Optionaloptions: Stream.ArrayOptions

                                                                                Returns Promise<boolean>

                                                                                a promise evaluating to true if fn returned a truthy value for every one of the chunks.

                                                                                -

                                                                                v17.5.0

                                                                                +
                                                                              • Optionaloptions: Stream.ArrayOptions

                                                                              Returns Promise<boolean>

                                                                              a promise evaluating to true if fn returned a truthy value for every one of the chunks.

                                                                              +

                                                                              v17.5.0

                                                                              • This method allows filtering the stream. For each chunk in the stream the fn function will be called and if it returns a truthy value, the chunk will be passed to the result stream. If the fn function returns a promise - that promise will be awaited.

                                                                                Parameters

                                                                                • fn: (
                                                                                      data: any,
                                                                                      options?: Pick<Stream.ArrayOptions, "signal">,
                                                                                  ) => boolean | Promise<boolean>

                                                                                  a function to filter chunks from the stream. Async or not.

                                                                                  -
                                                                                • Optionaloptions: Stream.ArrayOptions

                                                                                Returns Readable

                                                                                a stream filtered with the predicate fn.

                                                                                -

                                                                                v17.4.0, v16.14.0

                                                                                +
                                                                              • Optionaloptions: Stream.ArrayOptions

                                                                              Returns Readable

                                                                              a stream filtered with the predicate fn.

                                                                              +

                                                                              v17.4.0, v16.14.0

                                                                              • This method is similar to Array.prototype.find and calls fn on each chunk in the stream to find a chunk with a truthy value for fn. Once an fn call's awaited return value is truthy, the stream is destroyed and the promise is fulfilled with value for which fn returned a truthy value. If all of the fn calls on the chunks return a falsy value, the promise is fulfilled with undefined.

                                                                                Type Parameters

                                                                                • T

                                                                                Parameters

                                                                                Returns Promise<T>

                                                                                a promise evaluating to the first chunk for which fn evaluated with a truthy value, +

                                                                              • Optionaloptions: Stream.ArrayOptions

                                                                              Returns Promise<T>

                                                                              a promise evaluating to the first chunk for which fn evaluated with a truthy value, or undefined if no element was found.

                                                                              -

                                                                              v17.5.0

                                                                              +

                                                                              v17.5.0

                                                                            • This method is similar to Array.prototype.find and calls fn on each chunk in the stream to find a chunk with a truthy value for fn. Once an fn call's awaited return value is truthy, the stream is destroyed and the promise is fulfilled with value for which fn returned a truthy value. If all of the fn calls on the chunks return a falsy value, the promise is fulfilled with undefined.

                                                                              Parameters

                                                                              • fn: (
                                                                                    data: any,
                                                                                    options?: Pick<Stream.ArrayOptions, "signal">,
                                                                                ) => boolean | Promise<boolean>

                                                                                a function to call on each chunk of the stream. Async or not.

                                                                                -
                                                                              • Optionaloptions: Stream.ArrayOptions

                                                                              Returns Promise<any>

                                                                              a promise evaluating to the first chunk for which fn evaluated with a truthy value, +

                                                                            • Optionaloptions: Stream.ArrayOptions

                                                                              • Returns Promise<any>

                                                                              a promise evaluating to the first chunk for which fn evaluated with a truthy value, or undefined if no element was found.

                                                                              -

                                                                              v17.5.0

                                                                              +

                                                                              v17.5.0

                                                                              • This method returns a new stream by applying the given callback to each chunk of the stream and then flattening the result.

                                                                                It is possible to return a stream or another iterable or async iterable from fn and the result streams will be merged (flattened) into the returned stream.

                                                                                Parameters

                                                                                • fn: (data: any, options?: Pick<Stream.ArrayOptions, "signal">) => any

                                                                                  a function to map over every chunk in the stream. May be async. May be a stream or generator.

                                                                                  -
                                                                                • Optionaloptions: Stream.ArrayOptions

                                                                                Returns Readable

                                                                                a stream flat-mapped with the function fn.

                                                                                -

                                                                                v17.5.0

                                                                                +
                                                                              • Optionaloptions: Stream.ArrayOptions

                                                                              Returns Readable

                                                                              a stream flat-mapped with the function fn.

                                                                              +

                                                                              v17.5.0

                                                                              • This method allows iterating a stream. For each chunk in the stream the fn function will be called. If the fn function returns a promise - that promise will be awaited.

                                                                                This method is different from for await...of loops in that it can optionally process chunks concurrently. @@ -299,44 +302,44 @@

                                                                                This method is different from listening to the 'data' event in that it uses the readable event in the underlying machinary and can limit the number of concurrent fn calls.

                                                                                Parameters

                                                                                • fn: (
                                                                                      data: any,
                                                                                      options?: Pick<Stream.ArrayOptions, "signal">,
                                                                                  ) => void | Promise<void>

                                                                                  a function to call on each chunk of the stream. Async or not.

                                                                                  -
                                                                                • Optionaloptions: Stream.ArrayOptions

                                                                                Returns Promise<void>

                                                                                a promise for when the stream has finished.

                                                                                -

                                                                                v17.5.0

                                                                                +
                                                                              • Optionaloptions: Stream.ArrayOptions

                                                                              Returns Promise<void>

                                                                              a promise for when the stream has finished.

                                                                              +

                                                                              v17.5.0

                                                                              • The readable.isPaused() method returns the current operating state of the Readable. +

                                                                                Returns number

                                                                                v1.0.0

                                                                                +

                                                                              • The readable.isPaused() method returns the current operating state of the Readable. This is used primarily by the mechanism that underlies the readable.pipe() method. In most typical cases, there will be no reason to use this method directly.

                                                                                const readable = new stream.Readable();

                                                                                readable.isPaused(); // === false
                                                                                readable.pause();
                                                                                readable.isPaused(); // === true
                                                                                readable.resume();
                                                                                readable.isPaused(); // === false
                                                                                -

                                                                                Returns boolean

                                                                                v0.11.14

                                                                                +

                                                                                Returns boolean

                                                                                v0.11.14

                                                                              • The iterator created by this method gives users the option to cancel the destruction of the stream if the for await...of loop is exited by return, break, or throw, or if the iterator should destroy the stream if the stream emitted an error during iteration.

                                                                                Parameters

                                                                                • Optionaloptions: { destroyOnReturn?: boolean }
                                                                                  • OptionaldestroyOnReturn?: boolean

                                                                                    When set to false, calling return on the async iterator, or exiting a for await...of iteration using a break, return, or throw will not destroy the stream. Default: true.

                                                                                    -

                                                                                Returns AsyncIterator<any>

                                                                                v16.3.0

                                                                                +

                                                                              Returns AsyncIterator<any>

                                                                              v16.3.0

                                                                              • Returns the number of listeners listening for the event named eventName. If listener is provided, it will return how many times the listener is found in the list of the listeners of the event.

                                                                                Type Parameters

                                                                                • K

                                                                                Parameters

                                                                                • eventName: string | symbol

                                                                                  The name of the event being listened for

                                                                                  -
                                                                                • Optionallistener: Function

                                                                                  The event handler function

                                                                                  -

                                                                                Returns number

                                                                                v3.2.0

                                                                                -

                                                                              • Returns a copy of the array of listeners for the event named eventName.

                                                                                +
                                                                              • Optionallistener: Function

                                                                                The event handler function

                                                                                +

                                                                              Returns number

                                                                              v3.2.0

                                                                              +

                                                                              • Returns a copy of the array of listeners for the event named eventName.

                                                                                server.on('connection', (stream) => {
                                                                                  console.log('someone connected!');
                                                                                });
                                                                                console.log(util.inspect(server.listeners('connection')));
                                                                                // Prints: [ [Function] ]
                                                                                -

                                                                                Type Parameters

                                                                                • K

                                                                                Parameters

                                                                                • eventName: string | symbol

                                                                                Returns Function[]

                                                                                v0.1.26

                                                                                -

                                                                              • This method allows mapping over the stream. The fn function will be called for every chunk in the stream. +

                                                                                Type Parameters

                                                                                • K

                                                                                Parameters

                                                                                • eventName: string | symbol

                                                                                Returns Function[]

                                                                                v0.1.26

                                                                                +

                                                                              • This method allows mapping over the stream. The fn function will be called for every chunk in the stream. If the fn function returns a promise - that promise will be awaited before being passed to the result stream.

                                                                                Parameters

                                                                                Returns Readable

                                                                                a stream mapped with the function fn.

                                                                                -

                                                                                v17.4.0, v16.14.0

                                                                                +
                                                                              • Optionaloptions: Stream.ArrayOptions

                                                                              Returns Readable

                                                                              a stream mapped with the function fn.

                                                                              +

                                                                              v17.4.0, v16.14.0

                                                                              • Alias for emitter.removeListener().

                                                                                -

                                                                                Type Parameters

                                                                                • K

                                                                                Parameters

                                                                                • eventName: string | symbol
                                                                                • listener: (...args: any[]) => void

                                                                                Returns this

                                                                                v10.0.0

                                                                                -

                                                                              • Adds the listener function to the end of the listeners array for the event +

                                                                                Type Parameters

                                                                                • K

                                                                                Parameters

                                                                                • eventName: string | symbol
                                                                                • listener: (...args: any[]) => void

                                                                                Returns this

                                                                                v10.0.0

                                                                                +

                                                                              • Adds the listener function to the end of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.

                                                                                @@ -350,8 +353,8 @@

                                                                                Parameters

                                                                                • event: "close"
                                                                                • listener: () => void

                                                                                  The callback function

                                                                                  -

                                                                                Returns this

                                                                                v0.1.101

                                                                                -

                                                                              • Parameters

                                                                                • event: "data"
                                                                                • listener: (chunk: any) => void

                                                                                Returns this

                                                                              • Parameters

                                                                                • event: "end"
                                                                                • listener: () => void

                                                                                Returns this

                                                                              • Parameters

                                                                                • event: "error"
                                                                                • listener: (err: Error) => void

                                                                                Returns this

                                                                              • Parameters

                                                                                • event: "pause"
                                                                                • listener: () => void

                                                                                Returns this

                                                                              • Parameters

                                                                                • event: "readable"
                                                                                • listener: () => void

                                                                                Returns this

                                                                              • Parameters

                                                                                • event: "resume"
                                                                                • listener: () => void

                                                                                Returns this

                                                                              • Parameters

                                                                                • event: string | symbol
                                                                                • listener: (...args: any[]) => void

                                                                                Returns this

                                                                              • Adds a one-time listener function for the event named eventName. The +

                                                                              Returns this

                                                                              v0.1.101

                                                                              +

                                                                            • Parameters

                                                                              • event: "data"
                                                                              • listener: (chunk: any) => void

                                                                              Returns this

                                                                            • Parameters

                                                                              • event: "end"
                                                                              • listener: () => void

                                                                              Returns this

                                                                            • Parameters

                                                                              • event: "error"
                                                                              • listener: (err: Error) => void

                                                                              Returns this

                                                                            • Parameters

                                                                              • event: "pause"
                                                                              • listener: () => void

                                                                              Returns this

                                                                            • Parameters

                                                                              • event: "readable"
                                                                              • listener: () => void

                                                                              Returns this

                                                                            • Parameters

                                                                              • event: "resume"
                                                                              • listener: () => void

                                                                              Returns this

                                                                            • Parameters

                                                                              • event: string | symbol
                                                                              • listener: (...args: any[]) => void

                                                                              Returns this

                                                                              • Adds a one-time listener function for the event named eventName. The next time eventName is triggered, this listener is removed and then invoked.

                                                                                server.once('connection', (stream) => {
                                                                                  console.log('Ah, we have our first user!');
                                                                                });
                                                                                @@ -363,16 +366,16 @@

                                                                                Parameters

                                                                                • event: "close"
                                                                                • listener: () => void

                                                                                  The callback function

                                                                                  -

                                                                                Returns this

                                                                                v0.3.0

                                                                                -

                                                                              • Parameters

                                                                                • event: "data"
                                                                                • listener: (chunk: any) => void

                                                                                Returns this

                                                                              • Parameters

                                                                                • event: "end"
                                                                                • listener: () => void

                                                                                Returns this

                                                                              • Parameters

                                                                                • event: "error"
                                                                                • listener: (err: Error) => void

                                                                                Returns this

                                                                              • Parameters

                                                                                • event: "pause"
                                                                                • listener: () => void

                                                                                Returns this

                                                                              • Parameters

                                                                                • event: "readable"
                                                                                • listener: () => void

                                                                                Returns this

                                                                              • Parameters

                                                                                • event: "resume"
                                                                                • listener: () => void

                                                                                Returns this

                                                                              • Parameters

                                                                                • event: string | symbol
                                                                                • listener: (...args: any[]) => void

                                                                                Returns this

                                                                              • The readable.pause() method will cause a stream in flowing mode to stop +

                                                                              Returns this

                                                                              v0.3.0

                                                                              +

                                                                            • Parameters

                                                                              • event: "data"
                                                                              • listener: (chunk: any) => void

                                                                              Returns this

                                                                            • Parameters

                                                                              • event: "end"
                                                                              • listener: () => void

                                                                              Returns this

                                                                            • Parameters

                                                                              • event: "error"
                                                                              • listener: (err: Error) => void

                                                                              Returns this

                                                                            • Parameters

                                                                              • event: "pause"
                                                                              • listener: () => void

                                                                              Returns this

                                                                            • Parameters

                                                                              • event: "readable"
                                                                              • listener: () => void

                                                                              Returns this

                                                                            • Parameters

                                                                              • event: "resume"
                                                                              • listener: () => void

                                                                              Returns this

                                                                            • Parameters

                                                                              • event: string | symbol
                                                                              • listener: (...args: any[]) => void

                                                                              Returns this

                                                                              • The readable.pause() method will cause a stream in flowing mode to stop emitting 'data' events, switching out of flowing mode. Any data that becomes available will remain in the internal buffer.

                                                                                const readable = getReadableStreamSomehow();
                                                                                readable.on('data', (chunk) => {
                                                                                  console.log(`Received ${chunk.length} bytes of data.`);
                                                                                  readable.pause();
                                                                                  console.log('There will be no additional data for 1 second.');
                                                                                  setTimeout(() => {
                                                                                    console.log('Now data will start flowing again.');
                                                                                    readable.resume();
                                                                                  }, 1000);
                                                                                });

                                                                                The readable.pause() method has no effect if there is a 'readable' event listener.

                                                                                -

                                                                                Returns this

                                                                                v0.9.4

                                                                                -

                                                                              • Adds the listener function to the beginning of the listeners array for the +

                                                                                Returns this

                                                                                v0.9.4

                                                                                +

                                                                              • Adds the listener function to the beginning of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.

                                                                                @@ -381,22 +384,22 @@

                                                                                Returns a reference to the EventEmitter, so that calls can be chained.

                                                                                Parameters

                                                                                • event: "close"
                                                                                • listener: () => void

                                                                                  The callback function

                                                                                  -

                                                                                Returns this

                                                                                v6.0.0

                                                                                -

                                                                              • Parameters

                                                                                • event: "data"
                                                                                • listener: (chunk: any) => void

                                                                                Returns this

                                                                              • Parameters

                                                                                • event: "end"
                                                                                • listener: () => void

                                                                                Returns this

                                                                              • Parameters

                                                                                • event: "error"
                                                                                • listener: (err: Error) => void

                                                                                Returns this

                                                                              • Parameters

                                                                                • event: "pause"
                                                                                • listener: () => void

                                                                                Returns this

                                                                              • Parameters

                                                                                • event: "readable"
                                                                                • listener: () => void

                                                                                Returns this

                                                                              • Parameters

                                                                                • event: "resume"
                                                                                • listener: () => void

                                                                                Returns this

                                                                              • Parameters

                                                                                • event: string | symbol
                                                                                • listener: (...args: any[]) => void

                                                                                Returns this

                                                                              • Adds a one-timelistener function for the event named eventName to the beginning of the listeners array. The next time eventName is triggered, this +

                                                                              Returns this

                                                                              v6.0.0

                                                                              +

                                                                            • Parameters

                                                                              • event: "data"
                                                                              • listener: (chunk: any) => void

                                                                              Returns this

                                                                            • Parameters

                                                                              • event: "end"
                                                                              • listener: () => void

                                                                              Returns this

                                                                            • Parameters

                                                                              • event: "error"
                                                                              • listener: (err: Error) => void

                                                                              Returns this

                                                                            • Parameters

                                                                              • event: "pause"
                                                                              • listener: () => void

                                                                              Returns this

                                                                            • Parameters

                                                                              • event: "readable"
                                                                              • listener: () => void

                                                                              Returns this

                                                                            • Parameters

                                                                              • event: "resume"
                                                                              • listener: () => void

                                                                              Returns this

                                                                            • Parameters

                                                                              • event: string | symbol
                                                                              • listener: (...args: any[]) => void

                                                                              Returns this

                                                                              • Adds a one-timelistener function for the event named eventName to the beginning of the listeners array. The next time eventName is triggered, this listener is removed, and then invoked.

                                                                                server.prependOnceListener('connection', (stream) => {
                                                                                  console.log('Ah, we have our first user!');
                                                                                });

                                                                                Returns a reference to the EventEmitter, so that calls can be chained.

                                                                                Parameters

                                                                                • event: "close"
                                                                                • listener: () => void

                                                                                  The callback function

                                                                                  -

                                                                                Returns this

                                                                                v6.0.0

                                                                                -

                                                                              • Parameters

                                                                                • event: "data"
                                                                                • listener: (chunk: any) => void

                                                                                Returns this

                                                                              • Parameters

                                                                                • event: "end"
                                                                                • listener: () => void

                                                                                Returns this

                                                                              • Parameters

                                                                                • event: "error"
                                                                                • listener: (err: Error) => void

                                                                                Returns this

                                                                              • Parameters

                                                                                • event: "pause"
                                                                                • listener: () => void

                                                                                Returns this

                                                                              • Parameters

                                                                                • event: "readable"
                                                                                • listener: () => void

                                                                                Returns this

                                                                              • Parameters

                                                                                • event: "resume"
                                                                                • listener: () => void

                                                                                Returns this

                                                                              • Parameters

                                                                                • event: string | symbol
                                                                                • listener: (...args: any[]) => void

                                                                                Returns this

                                                                              • Parameters

                                                                                Returns boolean

                                                                              • Returns a copy of the array of listeners for the event named eventName, +

                                                                              Returns this

                                                                              v6.0.0

                                                                              +

                                                                            • Parameters

                                                                              • event: "data"
                                                                              • listener: (chunk: any) => void

                                                                              Returns this

                                                                            • Parameters

                                                                              • event: "end"
                                                                              • listener: () => void

                                                                              Returns this

                                                                            • Parameters

                                                                              • event: "error"
                                                                              • listener: (err: Error) => void

                                                                              Returns this

                                                                            • Parameters

                                                                              • event: "pause"
                                                                              • listener: () => void

                                                                              Returns this

                                                                            • Parameters

                                                                              • event: "readable"
                                                                              • listener: () => void

                                                                              Returns this

                                                                            • Parameters

                                                                              • event: "resume"
                                                                              • listener: () => void

                                                                              Returns this

                                                                            • Parameters

                                                                              • event: string | symbol
                                                                              • listener: (...args: any[]) => void

                                                                              Returns this

                                                                              • Parameters

                                                                                Returns boolean

                                                                              • Returns a copy of the array of listeners for the event named eventName, including any wrappers (such as those created by .once()).

                                                                                import { EventEmitter } from 'node:events';
                                                                                const emitter = new EventEmitter();
                                                                                emitter.once('log', () => console.log('log once'));

                                                                                // Returns a new Array with a function `onceWrapper` which has a property
                                                                                // `listener` which contains the original listener bound above
                                                                                const listeners = emitter.rawListeners('log');
                                                                                const logFnWrapper = listeners[0];

                                                                                // Logs "log once" to the console and does not unbind the `once` event
                                                                                logFnWrapper.listener();

                                                                                // Logs "log once" to the console and removes the listener
                                                                                logFnWrapper();

                                                                                emitter.on('log', () => console.log('log persistently'));
                                                                                // Will return a new Array with a single function bound by `.on()` above
                                                                                const newListeners = emitter.rawListeners('log');

                                                                                // Logs "log persistently" twice
                                                                                newListeners[0]();
                                                                                emitter.emit('log');
                                                                                -

                                                                                Type Parameters

                                                                                • K

                                                                                Parameters

                                                                                • eventName: string | symbol

                                                                                Returns Function[]

                                                                                v9.4.0

                                                                                -

                                                                              • The readable.read() method reads data out of the internal buffer and +

                                                                                Type Parameters

                                                                                • K

                                                                                Parameters

                                                                                • eventName: string | symbol

                                                                                Returns Function[]

                                                                                v9.4.0

                                                                                +

                                                                              • The readable.read() method reads data out of the internal buffer and returns it. If no data is available to be read, null is returned. By default, the data is returned as a Buffer object unless an encoding has been specified using the readable.setEncoding() method or the stream is operating @@ -433,7 +436,7 @@

                                                                                Calling read after the 'end' event has been emitted will return null. No runtime error will be raised.

                                                                                Parameters

                                                                                • Optionalsize: number

                                                                                  Optional argument to specify how much data to read.

                                                                                  -

                                                                                Returns any

                                                                                v0.9.4

                                                                                +

                                                                              Returns any

                                                                              v0.9.4

                                                                              • This method calls fn on each chunk of the stream in order, passing it the result from the calculation on the previous element. It returns a promise for the final value of the reduction.

                                                                                If no initial value is supplied the first chunk of the stream is used as the initial value. @@ -441,9 +444,9 @@

                                                                                The reducer function iterates the stream element-by-element which means that there is no concurrency parameter or parallelism. To perform a reduce concurrently, you can extract the async function to readable.map method.

                                                                                Type Parameters

                                                                                • T = any

                                                                                Parameters

                                                                                • fn: (previous: any, data: any, options?: Pick<Stream.ArrayOptions, "signal">) => T

                                                                                  a reducer function to call over every chunk in the stream. Async or not.

                                                                                  -
                                                                                • Optionalinitial: undefined

                                                                                  the initial value to use in the reduction.

                                                                                  -
                                                                                • Optionaloptions: Pick<Stream.ArrayOptions, "signal">

                                                                                Returns Promise<T>

                                                                                a promise for the final value of the reduction.

                                                                                -

                                                                                v17.5.0

                                                                                +
                                                                              • Optionalinitial: undefined

                                                                                the initial value to use in the reduction.

                                                                                +
                                                                              • Optionaloptions: Pick<Stream.ArrayOptions, "signal">

                                                                              Returns Promise<T>

                                                                              a promise for the final value of the reduction.

                                                                              +

                                                                              v17.5.0

                                                                            • This method calls fn on each chunk of the stream in order, passing it the result from the calculation on the previous element. It returns a promise for the final value of the reduction.

                                                                              If no initial value is supplied the first chunk of the stream is used as the initial value. @@ -451,16 +454,16 @@

                                                                              The reducer function iterates the stream element-by-element which means that there is no concurrency parameter or parallelism. To perform a reduce concurrently, you can extract the async function to readable.map method.

                                                                              Type Parameters

                                                                              • T = any

                                                                              Parameters

                                                                              • fn: (previous: T, data: any, options?: Pick<Stream.ArrayOptions, "signal">) => T

                                                                                a reducer function to call over every chunk in the stream. Async or not.

                                                                                -
                                                                              • initial: T

                                                                                the initial value to use in the reduction.

                                                                                -
                                                                              • Optionaloptions: Pick<Stream.ArrayOptions, "signal">

                                                                              Returns Promise<T>

                                                                              a promise for the final value of the reduction.

                                                                              -

                                                                              v17.5.0

                                                                              +
                                                                            • initial: T

                                                                              the initial value to use in the reduction.

                                                                              +
                                                                            • Optionaloptions: Pick<Stream.ArrayOptions, "signal">

                                                                              • Returns Promise<T>

                                                                              a promise for the final value of the reduction.

                                                                              +

                                                                              v17.5.0

                                                                              • Removes all listeners, or those of the specified eventName.

                                                                                It is bad practice to remove listeners added elsewhere in the code, particularly when the EventEmitter instance was created by some other component or module (e.g. sockets or file streams).

                                                                                Returns a reference to the EventEmitter, so that calls can be chained.

                                                                                -

                                                                                Parameters

                                                                                • OptionaleventName: string | symbol

                                                                                Returns this

                                                                                v0.1.26

                                                                                -

                                                                              • Removes the specified listener from the listener array for the event named eventName.

                                                                                +

                                                                                Parameters

                                                                                • OptionaleventName: string | symbol

                                                                                Returns this

                                                                                v0.1.26

                                                                                +

                                                                              • Removes the specified listener from the listener array for the event named eventName.

                                                                                const callback = (stream) => {
                                                                                  console.log('someone connected!');
                                                                                };
                                                                                server.on('connection', callback);
                                                                                // ...
                                                                                server.removeListener('connection', callback);
                                                                                @@ -486,8 +489,8 @@

                                                                                Returns a reference to the EventEmitter, so that calls can be chained.

                                                                                -

                                                                                Parameters

                                                                                • event: "close"
                                                                                • listener: () => void

                                                                                Returns this

                                                                                v0.1.26

                                                                                -

                                                                              • Parameters

                                                                                • event: "data"
                                                                                • listener: (chunk: any) => void

                                                                                Returns this

                                                                              • Parameters

                                                                                • event: "end"
                                                                                • listener: () => void

                                                                                Returns this

                                                                              • Parameters

                                                                                • event: "error"
                                                                                • listener: (err: Error) => void

                                                                                Returns this

                                                                              • Parameters

                                                                                • event: "pause"
                                                                                • listener: () => void

                                                                                Returns this

                                                                              • Parameters

                                                                                • event: "readable"
                                                                                • listener: () => void

                                                                                Returns this

                                                                              • Parameters

                                                                                • event: "resume"
                                                                                • listener: () => void

                                                                                Returns this

                                                                              • Parameters

                                                                                • event: string | symbol
                                                                                • listener: (...args: any[]) => void

                                                                                Returns this

                                                                              • The readable.resume() method causes an explicitly paused Readable stream to +

                                                                                Parameters

                                                                                • event: "close"
                                                                                • listener: () => void

                                                                                Returns this

                                                                                v0.1.26

                                                                                +

                                                                              • Parameters

                                                                                • event: "data"
                                                                                • listener: (chunk: any) => void

                                                                                Returns this

                                                                              • Parameters

                                                                                • event: "end"
                                                                                • listener: () => void

                                                                                Returns this

                                                                              • Parameters

                                                                                • event: "error"
                                                                                • listener: (err: Error) => void

                                                                                Returns this

                                                                              • Parameters

                                                                                • event: "pause"
                                                                                • listener: () => void

                                                                                Returns this

                                                                              • Parameters

                                                                                • event: "readable"
                                                                                • listener: () => void

                                                                                Returns this

                                                                              • Parameters

                                                                                • event: "resume"
                                                                                • listener: () => void

                                                                                Returns this

                                                                              • Parameters

                                                                                • event: string | symbol
                                                                                • listener: (...args: any[]) => void

                                                                                Returns this

                                                                              • The readable.resume() method causes an explicitly paused Readable stream to resume emitting 'data' events, switching the stream into flowing mode.

                                                                                The readable.resume() method can be used to fully consume the data from a stream without actually processing any of that data:

                                                                                @@ -495,7 +498,7 @@

                                                                                The readable.resume() method has no effect if there is a 'readable' event listener.

                                                                                -

                                                                                Returns this

                                                                                v0.9.4

                                                                                +

                                                                                Returns this

                                                                                v0.9.4

                                                                              • The readable.setEncoding() method sets the character encoding for data read from the Readable stream.

                                                                                By default, no encoding is assigned and stream data will be returned as Buffer objects. Setting an encoding causes the stream data @@ -509,29 +512,29 @@

                                                                                Parameters

                                                                                Returns this

                                                                                v0.9.4

                                                                                +

                                                                              Returns this

                                                                              v0.9.4

                                                                              • By default EventEmitters will print a warning if more than 10 listeners are added for a particular event. This is a useful default that helps finding memory leaks. The emitter.setMaxListeners() method allows the limit to be modified for this specific EventEmitter instance. The value can be set to Infinity (or 0) to indicate an unlimited number of listeners.

                                                                                Returns a reference to the EventEmitter, so that calls can be chained.

                                                                                -

                                                                                Parameters

                                                                                • n: number

                                                                                Returns this

                                                                                v0.3.5

                                                                                -

                                                                              • This method is similar to Array.prototype.some and calls fn on each chunk in the stream +

                                                                                Parameters

                                                                                • n: number

                                                                                Returns this

                                                                                v0.3.5

                                                                                +

                                                                              • This method is similar to Array.prototype.some and calls fn on each chunk in the stream until the awaited return value is true (or any truthy value). Once an fn call on a chunk awaited return value is truthy, the stream is destroyed and the promise is fulfilled with true. If none of the fn calls on the chunks return a truthy value, the promise is fulfilled with false.

                                                                                Parameters

                                                                                • fn: (
                                                                                      data: any,
                                                                                      options?: Pick<Stream.ArrayOptions, "signal">,
                                                                                  ) => boolean | Promise<boolean>

                                                                                  a function to call on each chunk of the stream. Async or not.

                                                                                  -
                                                                                • Optionaloptions: Stream.ArrayOptions

                                                                                Returns Promise<boolean>

                                                                                a promise evaluating to true if fn returned a truthy value for at least one of the chunks.

                                                                                -

                                                                                v17.5.0

                                                                                +
                                                                              • Optionaloptions: Stream.ArrayOptions

                                                                              Returns Promise<boolean>

                                                                              a promise evaluating to true if fn returned a truthy value for at least one of the chunks.

                                                                              +

                                                                              v17.5.0

                                                                              Returns Readable

                                                                              a stream with limit chunks taken.

                                                                              +

                                                                              v17.5.0

                                                                              • This method allows easily obtaining the contents of a stream.

                                                                                As this method reads the entire stream into memory, it negates the benefits of streams. It's intended for interoperability and convenience, not as the primary way to consume streams.

                                                                                Parameters

                                                                                Returns Promise<any[]>

                                                                                a promise containing an array with the contents of the stream.

                                                                                -

                                                                                v17.5.0

                                                                                +

                                                                                v17.5.0

                                                                              • The readable.unpipe() method detaches a Writable stream previously attached using the pipe method.

                                                                                If the destination is not specified, then all pipes are detached.

                                                                                @@ -541,7 +544,7 @@

                                                                                Parameters

                                                                                • Optionaldestination: WritableStream

                                                                                  Optional specific stream to unpipe

                                                                                  -

                                                                                Returns this

                                                                                v0.9.4

                                                                                +

                                                                              Returns this

                                                                              v0.9.4

                                                                              • Passing chunk as null signals the end of the stream (EOF) and behaves the same as readable.push(null), after which no more data can be written. The EOF signal is put at the end of the buffer and any buffered data will still be @@ -566,8 +569,8 @@ process of performing a read.

                                                                                Parameters

                                                                                • chunk: any

                                                                                  Chunk of data to unshift onto the read queue. For streams not operating in object mode, chunk must be a {string}, {Buffer}, {TypedArray}, {DataView} or null. For object mode streams, chunk may be any JavaScript value.

                                                                                  -
                                                                                • Optionalencoding: BufferEncoding

                                                                                  Encoding of string chunks. Must be a valid Buffer encoding, such as 'utf8' or 'ascii'.

                                                                                  -

                                                                                Returns void

                                                                                v0.9.11

                                                                                +
                                                                              • Optionalencoding: BufferEncoding

                                                                                Encoding of string chunks. Must be a valid Buffer encoding, such as 'utf8' or 'ascii'.

                                                                                +

                                                                              Returns void

                                                                              v0.9.11

                                                                              • Prior to Node.js 0.10, streams did not implement the entire node:stream module API as it is currently defined. (See Compatibility for more information.)

                                                                                When using an older Node.js library that emits 'data' events and has a pause method that is advisory only, the readable.wrap() method can be used to create a Readable @@ -580,7 +583,7 @@

                                                                                Parameters

                                                                                Returns this

                                                                                v0.9.4

                                                                                +

                                                                              Returns this

                                                                              v0.9.4

                                                                              • Listens once to the abort event on the provided signal.

                                                                                Listening to the abort event on abort signals is unsafe and may lead to resource leaks since another third party with the signal can @@ -595,13 +598,13 @@

                                                                                Parameters

                                                                                Returns Disposable

                                                                                Disposable that removes the abort listener.

                                                                                -

                                                                                v20.5.0

                                                                                -

                                                                              • A utility method for creating Readable Streams out of iterators.

                                                                                Parameters

                                                                                • iterable: Iterable<any, any, any> | AsyncIterable<any, any, any>

                                                                                  Object implementing the Symbol.asyncIterator or Symbol.iterator iterable protocol. Emits an 'error' event if a null value is passed.

                                                                                  -
                                                                                • Optionaloptions: Stream.ReadableOptions

                                                                                  Options provided to new stream.Readable([options]). By default, Readable.from() will set options.objectMode to true, unless this is explicitly opted out by setting options.objectMode to false.

                                                                                  -

                                                                                Returns Readable

                                                                                v12.3.0, v10.17.0

                                                                                +
                                                                              • Optionaloptions: Stream.ReadableOptions

                                                                                Options provided to new stream.Readable([options]). By default, Readable.from() will set options.objectMode to true, unless this is explicitly opted out by setting options.objectMode to false.

                                                                                +

                                                                              Returns Readable

                                                                              v12.3.0, v10.17.0

                                                                              • A utility method for creating a Readable from a web ReadableStream.

                                                                                -

                                                                                Parameters

                                                                                • readableStream: ReadableStream
                                                                                • Optionaloptions: Pick<
                                                                                      Stream.ReadableOptions,
                                                                                      "encoding"
                                                                                      | "highWaterMark"
                                                                                      | "objectMode"
                                                                                      | "signal",
                                                                                  >

                                                                                Returns Readable

                                                                                v17.0.0

                                                                                +

                                                                                Parameters

                                                                                • readableStream: ReadableStream
                                                                                • Optionaloptions: Pick<
                                                                                      Stream.ReadableOptions,
                                                                                      "encoding"
                                                                                      | "highWaterMark"
                                                                                      | "objectMode"
                                                                                      | "signal",
                                                                                  >

                                                                                Returns Readable

                                                                                v17.0.0

                                                                              • Returns a copy of the array of listeners for the event named eventName.

                                                                                For EventEmitters this behaves exactly the same as calling .listeners on the emitter.

                                                                                @@ -610,8 +613,8 @@ 
                                                                                import { getEventListeners, EventEmitter } from 'node:events';

                                                                                {
                                                                                  const ee = new EventEmitter();
                                                                                  const listener = () => console.log('Events are fun');
                                                                                  ee.on('foo', listener);
                                                                                  console.log(getEventListeners(ee, 'foo')); // [ [Function: listener] ]
                                                                                }
                                                                                {
                                                                                  const et = new EventTarget();
                                                                                  const listener = () => console.log('Events are fun');
                                                                                  et.addEventListener('foo', listener);
                                                                                  console.log(getEventListeners(et, 'foo')); // [ [Function: listener] ]
                                                                                }
                                                                                -

                                                                                Parameters

                                                                                Returns Function[]

                                                                                v15.2.0, v14.17.0

                                                                                -

                                                                              • Returns the currently set max amount of listeners.

                                                                                For EventEmitters this behaves exactly the same as calling .getMaxListeners on the emitter.

                                                                                For EventTargets this is the only way to get the max event listeners for the @@ -620,18 +623,18 @@ 

                                                                                import { getMaxListeners, setMaxListeners, EventEmitter } from 'node:events';

                                                                                {
                                                                                  const ee = new EventEmitter();
                                                                                  console.log(getMaxListeners(ee)); // 10
                                                                                  setMaxListeners(11, ee);
                                                                                  console.log(getMaxListeners(ee)); // 11
                                                                                }
                                                                                {
                                                                                  const et = new EventTarget();
                                                                                  console.log(getMaxListeners(et)); // 10
                                                                                  setMaxListeners(11, et);
                                                                                  console.log(getMaxListeners(et)); // 11
                                                                                }
                                                                                -

                                                                                Parameters

                                                                                Returns number

                                                                                v19.9.0

                                                                                -

                                                                              • Returns whether the stream has been read from or cancelled.

                                                                                +

                                                                                Parameters

                                                                                Returns boolean

                                                                                v16.8.0

                                                                              • A class method that returns the number of listeners for the given eventName registered on the given emitter.

                                                                                import { EventEmitter, listenerCount } from 'node:events';

                                                                                const myEmitter = new EventEmitter();
                                                                                myEmitter.on('event', () => {});
                                                                                myEmitter.on('event', () => {});
                                                                                console.log(listenerCount(myEmitter, 'event'));
                                                                                // Prints: 2

                                                                                Parameters

                                                                                • emitter: EventEmitter

                                                                                  The emitter to query

                                                                                  -
                                                                                • eventName: string | symbol

                                                                                  The event name

                                                                                  -

                                                                                Returns number

                                                                                v0.9.12

                                                                                +
                                                                              • eventName: string | symbol

                                                                                The event name

                                                                                +

                                                                              Returns number

                                                                              v0.9.12

                                                                              Since v3.2.0 - Use listenerCount instead.

                                                                              -
                                                                              • import { on, EventEmitter } from 'node:events';
                                                                                import process from 'node:process';

                                                                                const ee = new EventEmitter();

                                                                                // Emit later on
                                                                                process.nextTick(() => {
                                                                                  ee.emit('foo', 'bar');
                                                                                  ee.emit('foo', 42);
                                                                                });

                                                                                for await (const event of on(ee, 'foo')) {
                                                                                  // The execution of this inner block is synchronous and it
                                                                                  // processes one event at a time (even with await). Do not use
                                                                                  // if concurrent execution is required.
                                                                                  console.log(event); // prints ['bar'] [42]
                                                                                }
                                                                                // Unreachable here
+
                                                                              • import { on, EventEmitter } from 'node:events';
                                                                                import process from 'node:process';

                                                                                const ee = new EventEmitter();

                                                                                // Emit later on
                                                                                process.nextTick(() => {
                                                                                  ee.emit('foo', 'bar');
                                                                                  ee.emit('foo', 42);
                                                                                });

                                                                                for await (const event of on(ee, 'foo')) {
                                                                                  // The execution of this inner block is synchronous and it
                                                                                  // processes one event at a time (even with await). Do not use
                                                                                  // if concurrent execution is required.
                                                                                  console.log(event); // prints ['bar'] [42]
                                                                                }
                                                                                // Unreachable here

                                                                                Returns an AsyncIterator that iterates eventName events. It will throw @@ -647,8 +650,8 @@

                                                                                Parameters

                                                                                Returns AsyncIterator<any[]>

                                                                                An AsyncIterator that iterates eventName events emitted by the emitter

                                                                                -

                                                                                v13.6.0, v12.16.0

                                                                                -
                                                                              • import { on, EventEmitter } from 'node:events';
                                                                                import process from 'node:process';

                                                                                const ee = new EventEmitter();

                                                                                // Emit later on
                                                                                process.nextTick(() => {
                                                                                  ee.emit('foo', 'bar');
                                                                                  ee.emit('foo', 42);
                                                                                });

                                                                                for await (const event of on(ee, 'foo')) {
                                                                                  // The execution of this inner block is synchronous and it
                                                                                  // processes one event at a time (even with await). Do not use
                                                                                  // if concurrent execution is required.
                                                                                  console.log(event); // prints ['bar'] [42]
                                                                                }
                                                                                // Unreachable here
+
                                                                                v13.6.0, v12.16.0
                                                                                
+
                                                                              • import { on, EventEmitter } from 'node:events';
                                                                                import process from 'node:process';

                                                                                const ee = new EventEmitter();

                                                                                // Emit later on
                                                                                process.nextTick(() => {
                                                                                  ee.emit('foo', 'bar');
                                                                                  ee.emit('foo', 42);
                                                                                });

                                                                                for await (const event of on(ee, 'foo')) {
                                                                                  // The execution of this inner block is synchronous and it
                                                                                  // processes one event at a time (even with await). Do not use
                                                                                  // if concurrent execution is required.
                                                                                  console.log(event); // prints ['bar'] [42]
                                                                                }
                                                                                // Unreachable here

                                                                                Returns an AsyncIterator that iterates eventName events. It will throw @@ -664,8 +667,8 @@

                                                                                Parameters

                                                                                Returns AsyncIterator<any[]>

                                                                                An AsyncIterator that iterates eventName events emitted by the emitter

                                                                                -

                                                                                v13.6.0, v12.16.0

                                                                                -

                                                                              • Creates a Promise that is fulfilled when the EventEmitter emits the given +

                                                                                v13.6.0, v12.16.0

                                                                                +

                                                                              • Creates a Promise that is fulfilled when the EventEmitter emits the given event or that is rejected if the EventEmitter emits 'error' while waiting. The Promise will resolve with an array of all the arguments emitted to the given event.

                                                                                @@ -684,8 +687,8 @@ 
                                                                                import { EventEmitter, once } from 'node:events';

                                                                                const ee = new EventEmitter();
                                                                                const ac = new AbortController();

                                                                                async function foo(emitter, event, signal) {
                                                                                  try {
                                                                                    await once(emitter, event, { signal });
                                                                                    console.log('event emitted!');
                                                                                  } catch (error) {
                                                                                    if (error.name === 'AbortError') {
                                                                                      console.error('Waiting for the event was canceled!');
                                                                                    } else {
                                                                                      console.error('There was an error', error.message);
                                                                                    }
                                                                                  }
                                                                                }

                                                                                foo(ee, 'foo', ac.signal);
                                                                                ac.abort(); // Abort waiting for the event
                                                                                ee.emit('foo'); // Prints: Waiting for the event was canceled!
                                                                                -

                                                                                Parameters

                                                                                Returns Promise<any[]>

                                                                                v11.13.0, v10.16.0

                                                                                -

                                                                              • Creates a Promise that is fulfilled when the EventEmitter emits the given +

                                                                                Parameters

                                                                                Returns Promise<any[]>

                                                                                v11.13.0, v10.16.0

                                                                                +

                                                                              • Creates a Promise that is fulfilled when the EventEmitter emits the given event or that is rejected if the EventEmitter emits 'error' while waiting. The Promise will resolve with an array of all the arguments emitted to the given event.

                                                                                @@ -704,14 +707,14 @@ 
                                                                                import { EventEmitter, once } from 'node:events';

                                                                                const ee = new EventEmitter();
                                                                                const ac = new AbortController();

                                                                                async function foo(emitter, event, signal) {
                                                                                  try {
                                                                                    await once(emitter, event, { signal });
                                                                                    console.log('event emitted!');
                                                                                  } catch (error) {
                                                                                    if (error.name === 'AbortError') {
                                                                                      console.error('Waiting for the event was canceled!');
                                                                                    } else {
                                                                                      console.error('There was an error', error.message);
                                                                                    }
                                                                                  }
                                                                                }

                                                                                foo(ee, 'foo', ac.signal);
                                                                                ac.abort(); // Abort waiting for the event
                                                                                ee.emit('foo'); // Prints: Waiting for the event was canceled!
                                                                                -

                                                                                Parameters

                                                                                Returns Promise<any[]>

                                                                                v11.13.0, v10.16.0

                                                                                -
                                                                              • import { setMaxListeners, EventEmitter } from 'node:events';

                                                                                const target = new EventTarget();
                                                                                const emitter = new EventEmitter();

                                                                                setMaxListeners(5, target, emitter);
+

                                                                                Parameters

                                                                                Returns Promise<any[]>

                                                                                v11.13.0, v10.16.0

                                                                                +
                                                                              • import { setMaxListeners, EventEmitter } from 'node:events';

                                                                                const target = new EventTarget();
                                                                                const emitter = new EventEmitter();

                                                                                setMaxListeners(5, target, emitter);

                                                                                Parameters

                                                                                • Optionaln: number

                                                                                  A non-negative number. The maximum number of listeners per EventTarget event.

                                                                                  -
                                                                                • ...eventTargets: (EventEmitter<DefaultEventMap> | EventTarget)[]

                                                                                  Zero or more {EventTarget} or {EventEmitter} instances. If none are specified, n is set as the default max for all newly created {EventTarget} and {EventEmitter} +

                                                                                • ...eventTargets: (EventEmitter<DefaultEventMap> | EventTarget)[]

                                                                                  Zero or more {EventTarget} or {EventEmitter} instances. If none are specified, n is set as the default max for all newly created {EventTarget} and {EventEmitter} objects.

                                                                                  -

                                                                                Returns void

                                                                                v15.4.0

                                                                                -

                                                                              Returns void

                                                                              v15.4.0

                                                                              +

                                                                              Settings

                                                                              Member Visibility

                                                                              On This Page

                                                                              Constructors
                                                                              Properties
                                                                              Methods
                                                                              diff --git a/docs/classes/_internal_.Scalar.html b/docs/classes/_internal_.Scalar.html index 591a55d5..c55e0b7d 100644 --- a/docs/classes/_internal_.Scalar.html +++ b/docs/classes/_internal_.Scalar.html @@ -1,4 +1,4 @@ -Scalar | ts-lambda-api - v2.5.2
                                                                              ts-lambda-api - v2.5.2
                                                                                Preparing search index...

                                                                                Class Scalar<T>

                                                                                Type Parameters

                                                                                • T = unknown

                                                                                Hierarchy (View Summary)

                                                                                Index

                                                                                Constructors

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

                                                                                  Class Scalar<T>

                                                                                  Type Parameters

                                                                                  • T = unknown

                                                                                  Hierarchy (View Summary)

                                                                                  Index

                                                                                  Constructors

                                                                                  constructor

                                                                                  Properties

                                                                                  [NODE_TYPE] addToJSMap? anchor? @@ -17,25 +17,25 @@ toJS toJSON toString -

                                                                                  Constructors

                                                                                  • Type Parameters

                                                                                    • T = unknown

                                                                                    Parameters

                                                                                    • value: T

                                                                                    Returns Scalar<T>

                                                                                  Properties

                                                                                  "[NODE_TYPE]": symbol
                                                                                  addToJSMap?: (ctx: ToJSContext, map: MapLike, value: unknown) => void

                                                                                  Customize the way that a key-value pair is resolved. +

                                                                                  Constructors

                                                                                  • Type Parameters

                                                                                    • T = unknown

                                                                                    Parameters

                                                                                    • value: T

                                                                                    Returns Scalar<T>

                                                                                  Properties

                                                                                  "[NODE_TYPE]": symbol
                                                                                  addToJSMap?: (ctx: ToJSContext, map: MapLike, value: unknown) => void

                                                                                  Customize the way that a key-value pair is resolved. Used for YAML 1.1 !!merge << handling.

                                                                                  -
                                                                                  anchor?: string

                                                                                  An optional anchor on this node. Used by alias nodes.

                                                                                  -
                                                                                  comment?: string

                                                                                  A comment on or immediately after this

                                                                                  -
                                                                                  commentBefore?: string

                                                                                  A comment before this

                                                                                  -
                                                                                  format?: string

                                                                                  By default (undefined), numbers use decimal notation. +

                                                                                  anchor?: string

                                                                                  An optional anchor on this node. Used by alias nodes.

                                                                                  +
                                                                                  comment?: string

                                                                                  A comment on or immediately after this

                                                                                  +
                                                                                  commentBefore?: string

                                                                                  A comment before this

                                                                                  +
                                                                                  format?: string

                                                                                  By default (undefined), numbers use decimal notation. The YAML 1.2 core schema only supports 'HEX' and 'OCT'. The YAML 1.1 schema also supports 'BIN' and 'TIME'

                                                                                  -
                                                                                  minFractionDigits?: number

                                                                                  If value is a number, use this value when stringifying this node.

                                                                                  -
                                                                                  range?: Range

                                                                                  The [start, value-end, node-end] character offsets for the part of the +

                                                                                  minFractionDigits?: number

                                                                                  If value is a number, use this value when stringifying this node.

                                                                                  +
                                                                                  range?: Range

                                                                                  The [start, value-end, node-end] character offsets for the part of the source parsed into this node (undefined if not parsed). The value-end and node-end positions are themselves not included in their respective ranges.

                                                                                  -
                                                                                  source?: string

                                                                                  Set during parsing to the source string value

                                                                                  -
                                                                                  spaceBefore?: boolean

                                                                                  A blank line before this node and its commentBefore

                                                                                  -
                                                                                  srcToken?: Token

                                                                                  The CST token that was composed into this node.

                                                                                  -
                                                                                  tag?: string

                                                                                  A fully qualified tag, if required

                                                                                  -
                                                                                  type?: Type

                                                                                  The scalar style used for the node's string representation

                                                                                  -
                                                                                  value: T

                                                                                  Methods

                                                                                  • A plain JavaScript representation of this node.

                                                                                    -

                                                                                    Parameters

                                                                                    Returns any

                                                                                  • A plain JS representation of this node

                                                                                    -

                                                                                    Parameters

                                                                                    Returns any

                                                                                  • Returns string

                                                                                  Settings

                                                                                  Member Visibility

                                                                                  On This Page

                                                                                  Constructors
                                                                                  Properties
                                                                                  Methods
                                                                                  +
                                                                                  source?: string

                                                                                  Set during parsing to the source string value

                                                                                  +
                                                                                  spaceBefore?: boolean

                                                                                  A blank line before this node and its commentBefore

                                                                                  +
                                                                                  srcToken?: Token

                                                                                  The CST token that was composed into this node.

                                                                                  +
                                                                                  tag?: string

                                                                                  A fully qualified tag, if required

                                                                                  +
                                                                                  type?: Type

                                                                                  The scalar style used for the node's string representation

                                                                                  +
                                                                                  value: T

                                                                                  Methods

                                                                                  • A plain JavaScript representation of this node.

                                                                                    +

                                                                                    Parameters

                                                                                    Returns any

                                                                                  • A plain JS representation of this node

                                                                                    +

                                                                                    Parameters

                                                                                    Returns any

                                                                                  • Returns string

                                                                                  Settings

                                                                                  Member Visibility

                                                                                  On This Page

                                                                                  Constructors
                                                                                  Properties
                                                                                  Methods
                                                                                  diff --git a/docs/classes/_internal_.Socket.html b/docs/classes/_internal_.Socket.html index a01875c1..27473d43 100644 --- a/docs/classes/_internal_.Socket.html +++ b/docs/classes/_internal_.Socket.html @@ -2,13 +2,13 @@ (uses named pipes on Windows, and Unix domain sockets otherwise). It is also an EventEmitter.

                                                                                  A net.Socket can be created by the user and used directly to interact with -a server. For example, it is returned by createConnection, +a server. For example, it is returned by createConnection, so the user can use it to talk to the server.

                                                                                  It can also be created by Node.js and passed to the user when a connection 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 @@ -32,9 +32,9 @@ readableLength readableObjectMode readyState -remoteAddress? -remoteFamily? -remotePort? +remoteAddress +remoteFamily +remotePort timeout? writable writableAborted @@ -122,18 +122,18 @@ once setMaxListeners toWeb -

                                                                                  Constructors

                                                                                  Properties

                                                                                  allowHalfOpen: boolean

                                                                                  If false then the stream will automatically end the writable side when the +

                                                                                  Constructors

                                                                                  Properties

                                                                                  allowHalfOpen: boolean

                                                                                  If false then the stream will automatically end the writable side when the readable side ends. Set initially by the allowHalfOpen constructor option, which defaults to true.

                                                                                  This can be changed manually to change the half-open behavior of an existing Duplex stream instance, but must be changed before the 'end' event is emitted.

                                                                                  v0.9.4

                                                                                  -
                                                                                  autoSelectFamilyAttemptedAddresses: string[]

                                                                                  This property is only present if the family autoselection algorithm is enabled in socket.connect(options) +

                                                                                  autoSelectFamilyAttemptedAddresses: string[]

                                                                                  This property is only present if the family autoselection algorithm is enabled in socket.connect(options) and it is an array of the addresses that have been attempted.

                                                                                  Each address is a string in the form of $IP:$PORT. If the connection was successful, then the last address is the one that the socket is currently connected to.

                                                                                  v19.4.0

                                                                                  -
                                                                                  bufferSize: number

                                                                                  This property shows the number of characters buffered for writing. The buffer +

                                                                                  bufferSize: number

                                                                                  This property shows the number of characters buffered for writing. The buffer may contain strings whose length after encoding is not yet known. So this number is only an approximation of the number of bytes in the buffer.

                                                                                  net.Socket has the property that socket.write() always works. This is to @@ -146,32 +146,32 @@ "throttle" the data flows in their program with socket.pause() and socket.resume().

                                                                                  v0.3.8

                                                                                  Since v14.6.0 - Use writableLength instead.

                                                                                  -
                                                                                  bytesRead: number

                                                                                  The amount of received bytes.

                                                                                  +
                                                                                  bytesRead: number

                                                                                  The amount of received bytes.

                                                                                  v0.5.3

                                                                                  -
                                                                                  bytesWritten: number

                                                                                  The amount of bytes sent.

                                                                                  +
                                                                                  bytesWritten: number

                                                                                  The amount of bytes sent.

                                                                                  v0.5.3

                                                                                  -
                                                                                  closed: boolean

                                                                                  Is true after 'close' has been emitted.

                                                                                  +
                                                                                  closed: boolean

                                                                                  Is true after 'close' has been emitted.

                                                                                  v18.0.0

                                                                                  connecting: boolean

                                                                                  If true, socket.connect(options[, connectListener]) was called and has not yet finished. It will stay true until the socket becomes connected, then it is set to false and the 'connect' event is emitted. Note that the socket.connect(options[, connectListener]) callback is a listener for the 'connect' event.

                                                                                  v6.1.0

                                                                                  -
                                                                                  destroyed: boolean

                                                                                  See writable.destroyed for further details.

                                                                                  -
                                                                                  errored: Error

                                                                                  Returns error if the stream has been destroyed with an error.

                                                                                  +
                                                                                  destroyed: boolean

                                                                                  See writable.destroyed for further details.

                                                                                  +
                                                                                  errored: Error

                                                                                  Returns error if the stream has been destroyed with an error.

                                                                                  v18.0.0

                                                                                  localAddress?: string

                                                                                  The string representation of the local IP address the remote client is connecting on. For example, in a server listening on '0.0.0.0', if a client connects on '192.168.1.1', the value of socket.localAddress would be'192.168.1.1'.

                                                                                  v0.9.6

                                                                                  -
                                                                                  localFamily?: string

                                                                                  The string representation of the local IP family. 'IPv4' or 'IPv6'.

                                                                                  +
                                                                                  localFamily?: string

                                                                                  The string representation of the local IP family. 'IPv4' or 'IPv6'.

                                                                                  v18.8.0, v16.18.0

                                                                                  -
                                                                                  localPort?: number

                                                                                  The numeric representation of the local port. For example, 80 or 21.

                                                                                  +
                                                                                  localPort?: number

                                                                                  The numeric representation of the local port. For example, 80 or 21.

                                                                                  v0.9.6

                                                                                  -
                                                                                  pending: boolean

                                                                                  This is true if the socket is not connected yet, either because .connect()has not yet been called or because it is still in the process of connecting +

                                                                                  pending: boolean

                                                                                  This is true if the socket is not connected yet, either because .connect()has not yet been called or because it is still in the process of connecting (see socket.connecting).

                                                                                  v11.2.0, v10.16.0

                                                                                  -
                                                                                  readable: boolean

                                                                                  Is true if it is safe to call read, which means +

                                                                                  readable: boolean

                                                                                  Is true if it is safe to call read, which means the stream has not been destroyed or emitted 'error' or 'end'.

                                                                                  v11.4.0

                                                                                  readableAborted: boolean

                                                                                  Returns whether the stream was destroyed or errored before emitting 'end'.

                                                                                  @@ -201,48 +201,48 @@
                                                                                • If the stream is not readable and writable, it is writeOnly.

                                                                                  • v0.5.0

                                                                                  -
                                                                                  remoteAddress?: string

                                                                                  The string representation of the remote IP address. For example,'74.125.127.100' or '2001:4860:a005::68'. Value may be undefined if +

                                                                                  remoteAddress: string

                                                                                  The string representation of the remote IP address. For example,'74.125.127.100' or '2001:4860:a005::68'. Value may be undefined if the socket is destroyed (for example, if the client disconnected).

                                                                                  v0.5.10

                                                                                  -
                                                                                  remoteFamily?: string

                                                                                  The string representation of the remote IP family. 'IPv4' or 'IPv6'. Value may be undefined if +

                                                                                  remoteFamily: string

                                                                                  The string representation of the remote IP family. 'IPv4' or 'IPv6'. Value may be undefined if the socket is destroyed (for example, if the client disconnected).

                                                                                  v0.11.14

                                                                                  -
                                                                                  remotePort?: number

                                                                                  The numeric representation of the remote port. For example, 80 or 21. Value may be undefined if +

                                                                                  remotePort: number

                                                                                  The numeric representation of the remote port. For example, 80 or 21. Value may be undefined if the socket is destroyed (for example, if the client disconnected).

                                                                                  v0.5.10

                                                                                  -
                                                                                  timeout?: number

                                                                                  The socket timeout in milliseconds as set by socket.setTimeout(). +

                                                                                  timeout?: number

                                                                                  The socket timeout in milliseconds as set by socket.setTimeout(). It is undefined if a timeout has not been set.

                                                                                  v10.7.0

                                                                                  -
                                                                                  writable: boolean

                                                                                  Is true if it is safe to call writable.write(), which means +

                                                                                  writable: boolean

                                                                                  Is true if it is safe to call writable.write(), which means the stream has not been destroyed, errored, or ended.

                                                                                  v11.4.0

                                                                                  -
                                                                                  writableAborted: boolean

                                                                                  Returns whether the stream was destroyed or errored before emitting 'finish'.

                                                                                  +
                                                                                  writableAborted: boolean

                                                                                  Returns whether the stream was destroyed or errored before emitting 'finish'.

                                                                                  v18.0.0, v16.17.0

                                                                                  -
                                                                                  writableCorked: number

                                                                                  Number of times writable.uncork() needs to be +

                                                                                  writableCorked: number

                                                                                  Number of times writable.uncork() needs to be called in order to fully uncork the stream.

                                                                                  v13.2.0, v12.16.0

                                                                                  -
                                                                                  writableEnded: boolean

                                                                                  Is true after writable.end() has been called. This property +

                                                                                  writableEnded: boolean

                                                                                  Is true after writable.end() has been called. This property does not indicate whether the data has been flushed, for this use writable.writableFinished instead.

                                                                                  v12.9.0

                                                                                  -
                                                                                  writableFinished: boolean

                                                                                  Is set to true immediately before the 'finish' event is emitted.

                                                                                  +
                                                                                  writableFinished: boolean

                                                                                  Is set to true immediately before the 'finish' event is emitted.

                                                                                  v12.6.0

                                                                                  -
                                                                                  writableHighWaterMark: number

                                                                                  Return the value of highWaterMark passed when creating this Writable.

                                                                                  +
                                                                                  writableHighWaterMark: number

                                                                                  Return the value of highWaterMark passed when creating this Writable.

                                                                                  v9.3.0

                                                                                  -
                                                                                  writableLength: number

                                                                                  This property contains the number of bytes (or objects) in the queue +

                                                                                  writableLength: number

                                                                                  This property contains the number of bytes (or objects) in the queue ready to be written. The value provides introspection data regarding the status of the highWaterMark.

                                                                                  v9.4.0

                                                                                  -
                                                                                  writableNeedDrain: boolean

                                                                                  Is true if the stream's buffer has been full and stream will emit 'drain'.

                                                                                  +
                                                                                  writableNeedDrain: boolean

                                                                                  Is true if the stream's buffer has been full and stream will emit 'drain'.

                                                                                  v15.2.0, v14.17.0

                                                                                  -
                                                                                  writableObjectMode: boolean

                                                                                  Getter for the property objectMode of a given Writable stream.

                                                                                  +
                                                                                  writableObjectMode: boolean

                                                                                  Getter for the property objectMode of a given Writable stream.

                                                                                  v12.3.0

                                                                                  -
                                                                                  captureRejections: boolean

                                                                                  Value: boolean

                                                                                  +
                                                                                  captureRejections: boolean

                                                                                  Value: boolean

                                                                                  Change the default captureRejections option on all new EventEmitter objects.

                                                                                  v13.4.0, v12.16.0

                                                                                  -
                                                                                  captureRejectionSymbol: typeof captureRejectionSymbol

                                                                                  Value: Symbol.for('nodejs.rejection')

                                                                                  +
                                                                                  captureRejectionSymbol: typeof captureRejectionSymbol

                                                                                  Value: Symbol.for('nodejs.rejection')

                                                                                  See how to write a custom rejection handler.

                                                                                  v13.4.0, v12.16.0

                                                                                  -
                                                                                  defaultMaxListeners: number

                                                                                  By default, a maximum of 10 listeners can be registered for any single +

                                                                                  defaultMaxListeners: number

                                                                                  By default, a maximum of 10 listeners can be registered for any single event. This limit can be changed for individual EventEmitter instances using the emitter.setMaxListeners(n) method. To change the default for allEventEmitter instances, the events.defaultMaxListeners property @@ -267,13 +267,16 @@ listeners, respectively. Its name property is set to 'MaxListenersExceededWarning'.

                                                                                  v0.11.2

                                                                                  -
                                                                                  errorMonitor: typeof errorMonitor

                                                                                  This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

                                                                                  +
                                                                                  errorMonitor: typeof errorMonitor

                                                                                  This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

                                                                                  Installing a listener using this symbol does not change the behavior once an 'error' event is emitted. Therefore, the process will still crash if no regular 'error' listener is installed.

                                                                                  v13.6.0, v12.17.0

                                                                                  -

                                                                                  Methods

                                                                                  Optional_construct

                                                                                  • _construct(callback: (error?: Error) => void): void

                                                                                    Parameters

                                                                                    • callback: (error?: Error) => void

                                                                                    Returns void

                                                                                  _destroy

                                                                                  • _destroy(error: Error, callback: (error?: Error) => void): void

                                                                                    Parameters

                                                                                    • error: Error
                                                                                    • callback: (error?: Error) => void

                                                                                    Returns void

                                                                                  _final

                                                                                  • _final(callback: (error?: Error) => void): void

                                                                                    Parameters

                                                                                    • callback: (error?: Error) => void

                                                                                    Returns void

                                                                                  _read

                                                                                  • _read(size: number): void

                                                                                    Parameters

                                                                                    • size: number

                                                                                    Returns void

                                                                                  _write

                                                                                  • _write(
                                                                                        chunk: any,
                                                                                        encoding: BufferEncoding,
                                                                                        callback: (error?: Error) => void,
                                                                                    ): void

                                                                                    Parameters

                                                                                    Returns void

                                                                                  Optional_writev

                                                                                  • _writev(
                                                                                        chunks: { chunk: any; encoding: BufferEncoding }[],
                                                                                        callback: (error?: Error) => void,
                                                                                    ): void

                                                                                    Parameters

                                                                                    • chunks: { chunk: any; encoding: BufferEncoding }[]
                                                                                    • callback: (error?: Error) => void

                                                                                    Returns void

                                                                                  • Calls readable.destroy() with an AbortError and returns a promise that fulfills when the stream is finished.

                                                                                    +

                                                                                  Methods

                                                                                  Optional_construct

                                                                                  • _construct?(callback: (error?: Error) => void): void

                                                                                    Parameters

                                                                                    • callback: (error?: Error) => void

                                                                                    Returns void

                                                                                  _destroy

                                                                                  • _destroy(error: Error, callback: (error?: Error) => void): void

                                                                                    Parameters

                                                                                    • error: Error
                                                                                    • callback: (error?: Error) => void

                                                                                    Returns void

                                                                                  _final

                                                                                  • _final(callback: (error?: Error) => void): void

                                                                                    Parameters

                                                                                    • callback: (error?: Error) => void

                                                                                    Returns void

                                                                                  _read

                                                                                  • _read(size: number): void

                                                                                    Parameters

                                                                                    • size: number

                                                                                    Returns void

                                                                                  _write

                                                                                  • _write(
                                                                                        chunk: any,
                                                                                        encoding: BufferEncoding,
                                                                                        callback: (error?: Error) => void,
                                                                                    ): void

                                                                                    Parameters

                                                                                    Returns void

                                                                                  Optional_writev

                                                                                  • _writev?(
                                                                                        chunks: { chunk: any; encoding: BufferEncoding }[],
                                                                                        callback: (error?: Error) => void,
                                                                                    ): void

                                                                                    Parameters

                                                                                    • chunks: { chunk: any; encoding: BufferEncoding }[]
                                                                                    • callback: (error?: Error) => void

                                                                                    Returns void

                                                                                  • Calls readable.destroy() with an AbortError and returns +a promise that fulfills when the stream is finished.

                                                                                    Returns Promise<void>

                                                                                    v20.4.0

                                                                                    -

                                                                                  • Returns AsyncIterator<any>

                                                                                  • Type Parameters

                                                                                    • K

                                                                                    Parameters

                                                                                    • error: Error
                                                                                    • event: string | symbol
                                                                                    • ...args: AnyRest

                                                                                    Returns void

                                                                                  • events.EventEmitter

                                                                                    +

                                                                                  • Returns AsyncIterator<any>

                                                                                    AsyncIterator to fully consume the stream.

                                                                                    +

                                                                                    v10.0.0

                                                                                    +

                                                                                  • Type Parameters

                                                                                    • K

                                                                                    Parameters

                                                                                    • error: Error
                                                                                    • event: string | symbol
                                                                                    • ...args: AnyRest

                                                                                    Returns void

                                                                                  • events.EventEmitter

                                                                                    1. close
                                                                                    2. connect
                                                                                      3. @@ -288,7 +291,7 @@
                                                                                    3. ready
                                                                                    4. timeout
                                                                                    -

                                                                                    Parameters

                                                                                    • event: string
                                                                                    • listener: (...args: any[]) => void

                                                                                    Returns this

                                                                                  • events.EventEmitter

                                                                                    +

                                                                                    Parameters

                                                                                    • event: string
                                                                                    • listener: (...args: any[]) => void

                                                                                    Returns this

                                                                                  • events.EventEmitter

                                                                                    1. close
                                                                                    2. connect
                                                                                      3. @@ -303,7 +306,7 @@
                                                                                    3. ready
                                                                                    4. timeout
                                                                                    -

                                                                                    Parameters

                                                                                    • event: "close"
                                                                                    • listener: (hadError: boolean) => void

                                                                                    Returns this

                                                                                  • events.EventEmitter

                                                                                    +

                                                                                    Parameters

                                                                                    • event: "close"
                                                                                    • listener: (hadError: boolean) => void

                                                                                    Returns this

                                                                                  • events.EventEmitter

                                                                                    1. close
                                                                                    2. connect
                                                                                      3. @@ -318,7 +321,7 @@
                                                                                    3. ready
                                                                                    4. timeout
                                                                                    -

                                                                                    Parameters

                                                                                    • event: "connect"
                                                                                    • listener: () => void

                                                                                    Returns this

                                                                                  • events.EventEmitter

                                                                                    +

                                                                                    Parameters

                                                                                    • event: "connect"
                                                                                    • listener: () => void

                                                                                    Returns this

                                                                                  • events.EventEmitter

                                                                                    1. close
                                                                                    2. connect
                                                                                      3. @@ -333,7 +336,7 @@
                                                                                    3. ready
                                                                                    4. timeout
                                                                                    -

                                                                                    Parameters

                                                                                    • event: "connectionAttempt"
                                                                                    • listener: (ip: string, port: number, family: number) => void

                                                                                    Returns this

                                                                                  • events.EventEmitter

                                                                                    +

                                                                                    Parameters

                                                                                    • event: "connectionAttempt"
                                                                                    • listener: (ip: string, port: number, family: number) => void

                                                                                    Returns this

                                                                                  • events.EventEmitter

                                                                                    1. close
                                                                                    2. connect
                                                                                      3. @@ -348,7 +351,7 @@
                                                                                    3. ready
                                                                                    4. timeout
                                                                                    -

                                                                                    Parameters

                                                                                    • event: "connectionAttemptFailed"
                                                                                    • listener: (ip: string, port: number, family: number, error: Error) => void

                                                                                    Returns this

                                                                                  • events.EventEmitter

                                                                                    +

                                                                                    Parameters

                                                                                    • event: "connectionAttemptFailed"
                                                                                    • listener: (ip: string, port: number, family: number, error: Error) => void

                                                                                    Returns this

                                                                                  • events.EventEmitter

                                                                                    1. close
                                                                                    2. connect
                                                                                      3. @@ -363,7 +366,7 @@
                                                                                    3. ready
                                                                                    4. timeout
                                                                                    -

                                                                                    Parameters

                                                                                    • event: "connectionAttemptTimeout"
                                                                                    • listener: (ip: string, port: number, family: number) => void

                                                                                    Returns this

                                                                                  • events.EventEmitter

                                                                                    +

                                                                                    Parameters

                                                                                    • event: "connectionAttemptTimeout"
                                                                                    • listener: (ip: string, port: number, family: number) => void

                                                                                    Returns this

                                                                                  • events.EventEmitter

                                                                                    1. close
                                                                                    2. connect
                                                                                      3. @@ -378,7 +381,7 @@
                                                                                    3. ready
                                                                                    4. timeout
                                                                                    -

                                                                                    Parameters

                                                                                    • event: "data"
                                                                                    • listener: (data: Buffer) => void

                                                                                    Returns this

                                                                                  • events.EventEmitter

                                                                                    +

                                                                                    Parameters

                                                                                    Returns this

                                                                                  • events.EventEmitter

                                                                                    1. close
                                                                                    2. connect
                                                                                      3. @@ -393,7 +396,7 @@
                                                                                    3. ready
                                                                                    4. timeout
                                                                                    -

                                                                                    Parameters

                                                                                    • event: "drain"
                                                                                    • listener: () => void

                                                                                    Returns this

                                                                                  • events.EventEmitter

                                                                                    +

                                                                                    Parameters

                                                                                    • event: "drain"
                                                                                    • listener: () => void

                                                                                    Returns this

                                                                                  • events.EventEmitter

                                                                                    1. close
                                                                                    2. connect
                                                                                      3. @@ -408,7 +411,7 @@
                                                                                    3. ready
                                                                                    4. timeout
                                                                                    -

                                                                                    Parameters

                                                                                    • event: "end"
                                                                                    • listener: () => void

                                                                                    Returns this

                                                                                  • events.EventEmitter

                                                                                    +

                                                                                    Parameters

                                                                                    • event: "end"
                                                                                    • listener: () => void

                                                                                    Returns this

                                                                                  • events.EventEmitter

                                                                                    1. close
                                                                                    2. connect
                                                                                      3. @@ -423,7 +426,7 @@
                                                                                    3. ready
                                                                                    4. timeout
                                                                                    -

                                                                                    Parameters

                                                                                    • event: "error"
                                                                                    • listener: (err: Error) => void

                                                                                    Returns this

                                                                                  • events.EventEmitter

                                                                                    +

                                                                                    Parameters

                                                                                    • event: "error"
                                                                                    • listener: (err: Error) => void

                                                                                    Returns this

                                                                                  • events.EventEmitter

                                                                                    1. close
                                                                                    2. connect
                                                                                      3. @@ -438,7 +441,7 @@
                                                                                    3. ready
                                                                                    4. timeout
                                                                                    -

                                                                                    Parameters

                                                                                    • event: "lookup"
                                                                                    • listener: (err: Error, address: string, family: string | number, host: string) => void

                                                                                    Returns this

                                                                                  • events.EventEmitter

                                                                                    +

                                                                                    Parameters

                                                                                    • event: "lookup"
                                                                                    • listener: (err: Error, address: string, family: string | number, host: string) => void

                                                                                    Returns this

                                                                                  • events.EventEmitter

                                                                                    1. close
                                                                                    2. connect
                                                                                      3. @@ -453,7 +456,7 @@
                                                                                    3. ready
                                                                                    4. timeout
                                                                                    -

                                                                                    Parameters

                                                                                    • event: "ready"
                                                                                    • listener: () => void

                                                                                    Returns this

                                                                                  • events.EventEmitter

                                                                                    +

                                                                                    Parameters

                                                                                    • event: "ready"
                                                                                    • listener: () => void

                                                                                    Returns this

                                                                                  • events.EventEmitter

                                                                                    1. close
                                                                                    2. connect
                                                                                      3. @@ -468,14 +471,14 @@
                                                                                    3. ready
                                                                                    4. timeout
                                                                                    -

                                                                                    Parameters

                                                                                    • event: "timeout"
                                                                                    • listener: () => void

                                                                                    Returns this

                                                                                  • Returns the bound address, the address family name and port of the +

                                                                                    Parameters

                                                                                    • event: "timeout"
                                                                                    • listener: () => void

                                                                                    Returns this

                                                                                  • Returns the bound address, the address family name and port of the socket as reported by the operating system:{ port: 12346, family: 'IPv4', address: '127.0.0.1' }

                                                                                    -

                                                                                    Returns {} | AddressInfo

                                                                                    v0.1.90

                                                                                    -

                                                                                  • This method returns a new stream with chunks of the underlying stream paired with a counter +

                                                                                    Returns {} | AddressInfo

                                                                                    v0.1.90

                                                                                    +

                                                                                  • This method returns a new stream with chunks of the underlying stream paired with a counter in the form [index, chunk]. The first index value is 0 and it increases by 1 for each chunk produced.

                                                                                    Parameters

                                                                                    Returns Readable

                                                                                    a stream of indexed pairs.

                                                                                    -

                                                                                    v17.5.0

                                                                                    -

                                                                                  • Initiate a connection on a given socket.

                                                                                    +

                                                                                    v17.5.0

                                                                                    +

                                                                                  • Initiate a connection on a given socket.

                                                                                    Possible signatures:

                                                                                    • socket.connect(options[, connectListener])
                                                                                      • @@ -490,7 +493,7 @@ for the 'connect' event once.

                                                                                      This function should only be used for reconnecting a socket after'close' has been emitted or otherwise it may lead to undefined behavior.

                                                                                      -

                                                                                    Parameters

                                                                                    Returns this

                                                                                  • Initiate a connection on a given socket.

                                                                                    +

                                                                                    Parameters

                                                                                    Returns this

                                                                                  • Initiate a connection on a given socket.

                                                                                    Possible signatures:

                                                                                    • socket.connect(options[, connectListener])
                                                                                      • @@ -505,7 +508,7 @@ for the 'connect' event once.

                                                                                      This function should only be used for reconnecting a socket after'close' has been emitted or otherwise it may lead to undefined behavior.

                                                                                      -

                                                                                    Parameters

                                                                                    • port: number
                                                                                    • host: string
                                                                                    • OptionalconnectionListener: () => void

                                                                                    Returns this

                                                                                  • Initiate a connection on a given socket.

                                                                                    +

                                                                                    Parameters

                                                                                    • port: number
                                                                                    • host: string
                                                                                    • OptionalconnectionListener: () => void

                                                                                    Returns this

                                                                                  • Initiate a connection on a given socket.

                                                                                    Possible signatures:

                                                                                    • socket.connect(options[, connectListener])
                                                                                      • @@ -520,7 +523,7 @@ for the 'connect' event once.

                                                                                      This function should only be used for reconnecting a socket after'close' has been emitted or otherwise it may lead to undefined behavior.

                                                                                      -

                                                                                    Parameters

                                                                                    • port: number
                                                                                    • OptionalconnectionListener: () => void

                                                                                    Returns this

                                                                                  • Initiate a connection on a given socket.

                                                                                    +

                                                                                    Parameters

                                                                                    • port: number
                                                                                    • OptionalconnectionListener: () => void

                                                                                    Returns this

                                                                                  • Initiate a connection on a given socket.

                                                                                    Possible signatures:

                                                                                    • socket.connect(options[, connectListener])
                                                                                      • @@ -535,7 +538,7 @@ for the 'connect' event once.

                                                                                      This function should only be used for reconnecting a socket after'close' has been emitted or otherwise it may lead to undefined behavior.

                                                                                      -

                                                                                    Parameters

                                                                                    • path: string
                                                                                    • OptionalconnectionListener: () => void

                                                                                    Returns this

                                                                                  • The writable.cork() method forces all written data to be buffered in memory. +

                                                                                    Parameters

                                                                                    • path: string
                                                                                    • OptionalconnectionListener: () => void

                                                                                    Returns this

                                                                                  • The writable.cork() method forces all written data to be buffered in memory. The buffered data will be flushed when either the uncork or end methods are called.

                                                                                    The primary intent of writable.cork() is to accommodate a situation in which several small chunks are written to the stream in rapid succession. Instead of @@ -544,90 +547,90 @@ situation where data is being buffered while waiting for the first small chunk to be processed. However, use of writable.cork() without implementing writable._writev() may have an adverse effect on throughput.

                                                                                    See also: writable.uncork(), writable._writev().

                                                                                    -

                                                                                    Returns void

                                                                                    v0.11.2

                                                                                    -

                                                                                  • Destroy the stream. Optionally emit an 'error' event, and emit a 'close' event (unless emitClose is set to false). After this call, the readable +

                                                                                    Returns void

                                                                                    v0.11.2

                                                                                    +

                                                                                  • Destroy the stream. Optionally emit an 'error' event, and emit a 'close' event (unless emitClose is set to false). After this call, the readable stream will release any internal resources and subsequent calls to push() will be ignored.

                                                                                    Once destroy() has been called any further calls will be a no-op and no further errors except from _destroy() may be emitted as 'error'.

                                                                                    Implementors should not override this method, but instead implement readable._destroy().

                                                                                    Parameters

                                                                                    • Optionalerror: Error

                                                                                      Error which will be passed as payload in 'error' event

                                                                                      -

                                                                                    Returns this

                                                                                    v8.0.0

                                                                                    -

                                                                                  • Destroys the socket after all data is written. If the finish event was already emitted the socket is destroyed immediately. +

                                                                                  Returns this

                                                                                  v8.0.0

                                                                                  +

                                                                                  • Destroys the socket after all data is written. If the finish event was already emitted the socket is destroyed immediately. If the socket is still writable it implicitly calls socket.end().

                                                                                    -

                                                                                    Returns void

                                                                                    v0.3.4

                                                                                    -

                                                                                  • This method returns a new stream with the first limit chunks dropped from the start.

                                                                                    +

                                                                                    Returns void

                                                                                    v0.3.4

                                                                                    +

                                                                                  • This method returns a new stream with the first limit chunks dropped from the start.

                                                                                    Parameters

                                                                                    • limit: number

                                                                                      the number of chunks to drop from the readable.

                                                                                      -
                                                                                    • Optionaloptions: Pick<Stream.ArrayOptions, "signal">

                                                                                    Returns Readable

                                                                                    a stream with limit chunks dropped from the start.

                                                                                    -

                                                                                    v17.5.0

                                                                                    +
                                                                                  • Optionaloptions: Pick<Stream.ArrayOptions, "signal">

                                                                                  Returns Readable

                                                                                  a stream with limit chunks dropped from the start.

                                                                                  +

                                                                                  v17.5.0

                                                                                  • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

                                                                                    Returns true if the event had listeners, false otherwise.

                                                                                    import { EventEmitter } from 'node:events';
                                                                                    const myEmitter = new EventEmitter();

                                                                                    // First listener
                                                                                    myEmitter.on('event', function firstListener() {
                                                                                      console.log('Helloooo! first listener');
                                                                                    });
                                                                                    // Second listener
                                                                                    myEmitter.on('event', function secondListener(arg1, arg2) {
                                                                                      console.log(`event with parameters ${arg1}, ${arg2} in second listener`);
                                                                                    });
                                                                                    // Third listener
                                                                                    myEmitter.on('event', function thirdListener(...args) {
                                                                                      const parameters = args.join(', ');
                                                                                      console.log(`event with parameters ${parameters} in third listener`);
                                                                                    });

                                                                                    console.log(myEmitter.listeners('event'));

                                                                                    myEmitter.emit('event', 1, 2, 3, 4, 5);

                                                                                    // Prints:
                                                                                    // [
                                                                                    //   [Function: firstListener],
                                                                                    //   [Function: secondListener],
                                                                                    //   [Function: thirdListener]
                                                                                    // ]
                                                                                    // Helloooo! first listener
                                                                                    // event with parameters 1, 2 in second listener
                                                                                    // event with parameters 1, 2, 3, 4, 5 in third listener
                                                                                    -

                                                                                    Parameters

                                                                                    • event: string | symbol
                                                                                    • ...args: any[]

                                                                                    Returns boolean

                                                                                    v0.1.26

                                                                                    -

                                                                                  • Parameters

                                                                                    • event: "close"
                                                                                    • hadError: boolean

                                                                                    Returns boolean

                                                                                  • Parameters

                                                                                    • event: "connect"

                                                                                    Returns boolean

                                                                                  • Parameters

                                                                                    • event: "connectionAttempt"
                                                                                    • ip: string
                                                                                    • port: number
                                                                                    • family: number

                                                                                    Returns boolean

                                                                                  • Parameters

                                                                                    • event: "connectionAttemptFailed"
                                                                                    • ip: string
                                                                                    • port: number
                                                                                    • family: number
                                                                                    • error: Error

                                                                                    Returns boolean

                                                                                  • Parameters

                                                                                    • event: "connectionAttemptTimeout"
                                                                                    • ip: string
                                                                                    • port: number
                                                                                    • family: number

                                                                                    Returns boolean

                                                                                  • Parameters

                                                                                    • event: "data"
                                                                                    • data: Buffer

                                                                                    Returns boolean

                                                                                  • Parameters

                                                                                    • event: "drain"

                                                                                    Returns boolean

                                                                                  • Parameters

                                                                                    • event: "end"

                                                                                    Returns boolean

                                                                                  • Parameters

                                                                                    • event: "error"
                                                                                    • err: Error

                                                                                    Returns boolean

                                                                                  • Parameters

                                                                                    • event: "lookup"
                                                                                    • err: Error
                                                                                    • address: string
                                                                                    • family: string | number
                                                                                    • host: string

                                                                                    Returns boolean

                                                                                  • Parameters

                                                                                    • event: "ready"

                                                                                    Returns boolean

                                                                                  • Parameters

                                                                                    • event: "timeout"

                                                                                    Returns boolean

                                                                                  • Half-closes the socket. i.e., it sends a FIN packet. It is possible the +

                                                                                    Parameters

                                                                                    • event: string | symbol
                                                                                    • ...args: any[]

                                                                                    Returns boolean

                                                                                    v0.1.26

                                                                                    +

                                                                                  • Parameters

                                                                                    • event: "close"
                                                                                    • hadError: boolean

                                                                                    Returns boolean

                                                                                  • Parameters

                                                                                    • event: "connect"

                                                                                    Returns boolean

                                                                                  • Parameters

                                                                                    • event: "connectionAttempt"
                                                                                    • ip: string
                                                                                    • port: number
                                                                                    • family: number

                                                                                    Returns boolean

                                                                                  • Parameters

                                                                                    • event: "connectionAttemptFailed"
                                                                                    • ip: string
                                                                                    • port: number
                                                                                    • family: number
                                                                                    • error: Error

                                                                                    Returns boolean

                                                                                  • Parameters

                                                                                    • event: "connectionAttemptTimeout"
                                                                                    • ip: string
                                                                                    • port: number
                                                                                    • family: number

                                                                                    Returns boolean

                                                                                  • Parameters

                                                                                    Returns boolean

                                                                                  • Parameters

                                                                                    • event: "drain"

                                                                                    Returns boolean

                                                                                  • Parameters

                                                                                    • event: "end"

                                                                                    Returns boolean

                                                                                  • Parameters

                                                                                    • event: "error"
                                                                                    • err: Error

                                                                                    Returns boolean

                                                                                  • Parameters

                                                                                    • event: "lookup"
                                                                                    • err: Error
                                                                                    • address: string
                                                                                    • family: string | number
                                                                                    • host: string

                                                                                    Returns boolean

                                                                                  • Parameters

                                                                                    • event: "ready"

                                                                                    Returns boolean

                                                                                  • Parameters

                                                                                    • event: "timeout"

                                                                                    Returns boolean

                                                                                  • Half-closes the socket. i.e., it sends a FIN packet. It is possible the server will still send some data.

                                                                                    See writable.end() for further details.

                                                                                    Parameters

                                                                                    • Optionalcallback: () => void

                                                                                      Optional callback for when the socket is finished.

                                                                                      -

                                                                                    Returns this

                                                                                    The socket itself.

                                                                                    -

                                                                                    v0.1.90

                                                                                    -

                                                                                  • Half-closes the socket. i.e., it sends a FIN packet. It is possible the +

                                                                                  Returns this

                                                                                  The socket itself.

                                                                                  +

                                                                                  v0.1.90

                                                                                  +

                                                                                • Half-closes the socket. i.e., it sends a FIN packet. It is possible the server will still send some data.

                                                                                  See writable.end() for further details.

                                                                                  Parameters

                                                                                  • buffer: string | Uint8Array<ArrayBufferLike>
                                                                                  • Optionalcallback: () => void

                                                                                    Optional callback for when the socket is finished.

                                                                                    -

                                                                                  Returns this

                                                                                  The socket itself.

                                                                                  -

                                                                                  v0.1.90

                                                                                  -

                                                                                • Half-closes the socket. i.e., it sends a FIN packet. It is possible the +

                                                                                  • Returns this

                                                                                  The socket itself.

                                                                                  +

                                                                                  v0.1.90

                                                                                  +

                                                                                • Half-closes the socket. i.e., it sends a FIN packet. It is possible the server will still send some data.

                                                                                  See writable.end() for further details.

                                                                                  Parameters

                                                                                  • str: string | Uint8Array<ArrayBufferLike>
                                                                                  • Optionalencoding: BufferEncoding

                                                                                    Only used when data is string.

                                                                                    -
                                                                                  • Optionalcallback: () => void

                                                                                    Optional callback for when the socket is finished.

                                                                                    -

                                                                                  Returns this

                                                                                  The socket itself.

                                                                                  -

                                                                                  v0.1.90

                                                                                  -

                                                                                  • Returns an array listing the events for which the emitter has registered +

                                                                                  • Optionalcallback: () => void

                                                                                    Optional callback for when the socket is finished.

                                                                                    +

                                                                                  Returns this

                                                                                  The socket itself.

                                                                                  +

                                                                                  v0.1.90

                                                                                  +

                                                                                  • Returns an array listing the events for which the emitter has registered listeners. The values in the array are strings or Symbols.

                                                                                    import { EventEmitter } from 'node:events';

                                                                                    const myEE = new EventEmitter();
                                                                                    myEE.on('foo', () => {});
                                                                                    myEE.on('bar', () => {});

                                                                                    const sym = Symbol('symbol');
                                                                                    myEE.on(sym, () => {});

                                                                                    console.log(myEE.eventNames());
                                                                                    // Prints: [ 'foo', 'bar', Symbol(symbol) ]
                                                                                    -

                                                                                    Returns (string | symbol)[]

                                                                                    v6.0.0

                                                                                    -

                                                                                  • This method is similar to Array.prototype.every and calls fn on each chunk in the stream +

                                                                                    Returns (string | symbol)[]

                                                                                    v6.0.0

                                                                                    +

                                                                                  • This method is similar to Array.prototype.every and calls fn on each chunk in the stream to check if all awaited return values are truthy value for fn. Once an fn call on a chunk awaited return value is falsy, the stream is destroyed and the promise is fulfilled with false. If all of the fn calls on the chunks return a truthy value, the promise is fulfilled with true.

                                                                                    Parameters

                                                                                    • fn: (
                                                                                          data: any,
                                                                                          options?: Pick<Stream.ArrayOptions, "signal">,
                                                                                      ) => boolean | Promise<boolean>

                                                                                      a function to call on each chunk of the stream. Async or not.

                                                                                      -
                                                                                    • Optionaloptions: Stream.ArrayOptions

                                                                                    Returns Promise<boolean>

                                                                                    a promise evaluating to true if fn returned a truthy value for every one of the chunks.

                                                                                    -

                                                                                    v17.5.0

                                                                                    -

                                                                                  • This method allows filtering the stream. For each chunk in the stream the fn function will be called +

                                                                                  • Optionaloptions: Stream.ArrayOptions

                                                                                  Returns Promise<boolean>

                                                                                  a promise evaluating to true if fn returned a truthy value for every one of the chunks.

                                                                                  +

                                                                                  v17.5.0

                                                                                  +

                                                                                  • This method allows filtering the stream. For each chunk in the stream the fn function will be called and if it returns a truthy value, the chunk will be passed to the result stream. If the fn function returns a promise - that promise will be awaited.

                                                                                    Parameters

                                                                                    • fn: (
                                                                                          data: any,
                                                                                          options?: Pick<Stream.ArrayOptions, "signal">,
                                                                                      ) => boolean | Promise<boolean>

                                                                                      a function to filter chunks from the stream. Async or not.

                                                                                      -
                                                                                    • Optionaloptions: Stream.ArrayOptions

                                                                                    Returns Readable

                                                                                    a stream filtered with the predicate fn.

                                                                                    -

                                                                                    v17.4.0, v16.14.0

                                                                                    -

                                                                                  • This method is similar to Array.prototype.find and calls fn on each chunk in the stream +

                                                                                  • Optionaloptions: Stream.ArrayOptions

                                                                                  Returns Readable

                                                                                  a stream filtered with the predicate fn.

                                                                                  +

                                                                                  v17.4.0, v16.14.0

                                                                                  +

                                                                                  • This method is similar to Array.prototype.find and calls fn on each chunk in the stream to find a chunk with a truthy value for fn. Once an fn call's awaited return value is truthy, the stream is destroyed and the promise is fulfilled with value for which fn returned a truthy value. If all of the fn calls on the chunks return a falsy value, the promise is fulfilled with undefined.

                                                                                    Type Parameters

                                                                                    • T

                                                                                    Parameters

                                                                                    Returns Promise<T>

                                                                                    a promise evaluating to the first chunk for which fn evaluated with a truthy value, +

                                                                                  • Optionaloptions: Stream.ArrayOptions

                                                                                  Returns Promise<T>

                                                                                  a promise evaluating to the first chunk for which fn evaluated with a truthy value, or undefined if no element was found.

                                                                                  -

                                                                                  v17.5.0

                                                                                  -

                                                                                • This method is similar to Array.prototype.find and calls fn on each chunk in the stream +

                                                                                  v17.5.0

                                                                                  +

                                                                                • This method is similar to Array.prototype.find and calls fn on each chunk in the stream to find a chunk with a truthy value for fn. Once an fn call's awaited return value is truthy, the stream is destroyed and the promise is fulfilled with value for which fn returned a truthy value. If all of the fn calls on the chunks return a falsy value, the promise is fulfilled with undefined.

                                                                                  Parameters

                                                                                  • fn: (
                                                                                        data: any,
                                                                                        options?: Pick<Stream.ArrayOptions, "signal">,
                                                                                    ) => boolean | Promise<boolean>

                                                                                    a function to call on each chunk of the stream. Async or not.

                                                                                    -
                                                                                  • Optionaloptions: Stream.ArrayOptions

                                                                                  Returns Promise<any>

                                                                                  a promise evaluating to the first chunk for which fn evaluated with a truthy value, +

                                                                                • Optionaloptions: Stream.ArrayOptions

                                                                                  • Returns Promise<any>

                                                                                  a promise evaluating to the first chunk for which fn evaluated with a truthy value, or undefined if no element was found.

                                                                                  -

                                                                                  v17.5.0

                                                                                  -

                                                                                  • This method returns a new stream by applying the given callback to each chunk of the stream +

                                                                                    v17.5.0

                                                                                    +

                                                                                  • This method returns a new stream by applying the given callback to each chunk of the stream and then flattening the result.

                                                                                    It is possible to return a stream or another iterable or async iterable from fn and the result streams will be merged (flattened) into the returned stream.

                                                                                    Parameters

                                                                                    • fn: (data: any, options?: Pick<Stream.ArrayOptions, "signal">) => any

                                                                                      a function to map over every chunk in the stream. May be async. May be a stream or generator.

                                                                                      -
                                                                                    • Optionaloptions: Stream.ArrayOptions

                                                                                    Returns Readable

                                                                                    a stream flat-mapped with the function fn.

                                                                                    -

                                                                                    v17.5.0

                                                                                    -

                                                                                  • This method allows iterating a stream. For each chunk in the stream the fn function will be called. +

                                                                                  • Optionaloptions: Stream.ArrayOptions

                                                                                  Returns Readable

                                                                                  a stream flat-mapped with the function fn.

                                                                                  +

                                                                                  v17.5.0

                                                                                  +

                                                                                  • This method allows iterating a stream. For each chunk in the stream the fn function will be called. If the fn function returns a promise - that promise will be awaited.

                                                                                    This method is different from for await...of loops in that it can optionally process chunks concurrently. In addition, a forEach iteration can only be stopped by having passed a signal option @@ -636,44 +639,44 @@

                                                                                    This method is different from listening to the 'data' event in that it uses the readable event in the underlying machinary and can limit the number of concurrent fn calls.

                                                                                    Parameters

                                                                                    • fn: (
                                                                                          data: any,
                                                                                          options?: Pick<Stream.ArrayOptions, "signal">,
                                                                                      ) => void | Promise<void>

                                                                                      a function to call on each chunk of the stream. Async or not.

                                                                                      -
                                                                                    • Optionaloptions: Stream.ArrayOptions

                                                                                    Returns Promise<void>

                                                                                    a promise for when the stream has finished.

                                                                                    -

                                                                                    v17.5.0

                                                                                    -

                                                                                  • Returns the current max listener value for the EventEmitter which is either +

                                                                                  • Optionaloptions: Stream.ArrayOptions

                                                                                  Returns Promise<void>

                                                                                  a promise for when the stream has finished.

                                                                                  +

                                                                                  v17.5.0

                                                                                  +

                                                                                  • Returns the current max listener value for the EventEmitter which is either set by emitter.setMaxListeners(n) or defaults to EventEmitter.defaultMaxListeners.

                                                                                    -

                                                                                    Returns number

                                                                                    v1.0.0

                                                                                    -

                                                                                  • The readable.isPaused() method returns the current operating state of the Readable. +

                                                                                    Returns number

                                                                                    v1.0.0

                                                                                    +

                                                                                  • The readable.isPaused() method returns the current operating state of the Readable. This is used primarily by the mechanism that underlies the readable.pipe() method. In most typical cases, there will be no reason to use this method directly.

                                                                                    const readable = new stream.Readable();

                                                                                    readable.isPaused(); // === false
                                                                                    readable.pause();
                                                                                    readable.isPaused(); // === true
                                                                                    readable.resume();
                                                                                    readable.isPaused(); // === false
                                                                                    -

                                                                                    Returns boolean

                                                                                    v0.11.14

                                                                                    +

                                                                                    Returns boolean

                                                                                    v0.11.14

                                                                                  • The iterator created by this method gives users the option to cancel the destruction of the stream if the for await...of loop is exited by return, break, or throw, or if the iterator should destroy the stream if the stream emitted an error during iteration.

                                                                                    Parameters

                                                                                    • Optionaloptions: { destroyOnReturn?: boolean }
                                                                                      • OptionaldestroyOnReturn?: boolean

                                                                                        When set to false, calling return on the async iterator, or exiting a for await...of iteration using a break, return, or throw will not destroy the stream. Default: true.

                                                                                        -

                                                                                    Returns AsyncIterator<any>

                                                                                    v16.3.0

                                                                                    -

                                                                                  • Returns the number of listeners listening for the event named eventName. +

                                                                                  Returns AsyncIterator<any>

                                                                                  v16.3.0

                                                                                  +

                                                                                  • Returns the number of listeners listening for the event named eventName. If listener is provided, it will return how many times the listener is found in the list of the listeners of the event.

                                                                                    Type Parameters

                                                                                    • K

                                                                                    Parameters

                                                                                    • eventName: string | symbol

                                                                                      The name of the event being listened for

                                                                                      -
                                                                                    • Optionallistener: Function

                                                                                      The event handler function

                                                                                      -

                                                                                    Returns number

                                                                                    v3.2.0

                                                                                    -

                                                                                  • Returns a copy of the array of listeners for the event named eventName.

                                                                                    +
                                                                                  • Optionallistener: Function

                                                                                    The event handler function

                                                                                    +

                                                                                  Returns number

                                                                                  v3.2.0

                                                                                  +

                                                                                  • Returns a copy of the array of listeners for the event named eventName.

                                                                                    server.on('connection', (stream) => {
                                                                                      console.log('someone connected!');
                                                                                    });
                                                                                    console.log(util.inspect(server.listeners('connection')));
                                                                                    // Prints: [ [Function] ]
                                                                                    -

                                                                                    Type Parameters

                                                                                    • K

                                                                                    Parameters

                                                                                    • eventName: string | symbol

                                                                                    Returns Function[]

                                                                                    v0.1.26

                                                                                    -

                                                                                  • This method allows mapping over the stream. The fn function will be called for every chunk in the stream. +

                                                                                    Type Parameters

                                                                                    • K

                                                                                    Parameters

                                                                                    • eventName: string | symbol

                                                                                    Returns Function[]

                                                                                    v0.1.26

                                                                                    +

                                                                                  • This method allows mapping over the stream. The fn function will be called for every chunk in the stream. If the fn function returns a promise - that promise will be awaited before being passed to the result stream.

                                                                                    Parameters

                                                                                    Returns Readable

                                                                                    a stream mapped with the function fn.

                                                                                    -

                                                                                    v17.4.0, v16.14.0

                                                                                    -

                                                                                  • Alias for emitter.removeListener().

                                                                                    -

                                                                                    Type Parameters

                                                                                    • K

                                                                                    Parameters

                                                                                    • eventName: string | symbol
                                                                                    • listener: (...args: any[]) => void

                                                                                    Returns this

                                                                                    v10.0.0

                                                                                    -

                                                                                  • Adds the listener function to the end of the listeners array for the event +

                                                                                  • Optionaloptions: Stream.ArrayOptions

                                                                                  Returns Readable

                                                                                  a stream mapped with the function fn.

                                                                                  +

                                                                                  v17.4.0, v16.14.0

                                                                                  +

                                                                                  • Alias for emitter.removeListener().

                                                                                    +

                                                                                    Type Parameters

                                                                                    • K

                                                                                    Parameters

                                                                                    • eventName: string | symbol
                                                                                    • listener: (...args: any[]) => void

                                                                                    Returns this

                                                                                    v10.0.0

                                                                                    +

                                                                                  • Adds the listener function to the end of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.

                                                                                    @@ -687,8 +690,8 @@

                                                                                    Parameters

                                                                                    • event: string
                                                                                    • listener: (...args: any[]) => void

                                                                                      The callback function

                                                                                      -

                                                                                    Returns this

                                                                                    v0.1.101

                                                                                    -

                                                                                  • Parameters

                                                                                    • event: "close"
                                                                                    • listener: (hadError: boolean) => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: "connect"
                                                                                    • listener: () => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: "connectionAttempt"
                                                                                    • listener: (ip: string, port: number, family: number) => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: "connectionAttemptFailed"
                                                                                    • listener: (ip: string, port: number, family: number, error: Error) => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: "connectionAttemptTimeout"
                                                                                    • listener: (ip: string, port: number, family: number) => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: "data"
                                                                                    • listener: (data: Buffer) => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: "drain"
                                                                                    • listener: () => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: "end"
                                                                                    • listener: () => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: "error"
                                                                                    • listener: (err: Error) => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: "lookup"
                                                                                    • listener: (err: Error, address: string, family: string | number, host: string) => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: "ready"
                                                                                    • listener: () => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: "timeout"
                                                                                    • listener: () => void

                                                                                    Returns this

                                                                                  • Adds a one-time listener function for the event named eventName. The +

                                                                                  Returns this

                                                                                  v0.1.101

                                                                                  +

                                                                                • Parameters

                                                                                  • event: "close"
                                                                                  • listener: (hadError: boolean) => void

                                                                                  Returns this

                                                                                • Parameters

                                                                                  • event: "connect"
                                                                                  • listener: () => void

                                                                                  Returns this

                                                                                • Parameters

                                                                                  • event: "connectionAttempt"
                                                                                  • listener: (ip: string, port: number, family: number) => void

                                                                                  Returns this

                                                                                • Parameters

                                                                                  • event: "connectionAttemptFailed"
                                                                                  • listener: (ip: string, port: number, family: number, error: Error) => void

                                                                                  Returns this

                                                                                • Parameters

                                                                                  • event: "connectionAttemptTimeout"
                                                                                  • listener: (ip: string, port: number, family: number) => void

                                                                                  Returns this

                                                                                • Parameters

                                                                                  Returns this

                                                                                • Parameters

                                                                                  • event: "drain"
                                                                                  • listener: () => void

                                                                                  Returns this

                                                                                • Parameters

                                                                                  • event: "end"
                                                                                  • listener: () => void

                                                                                  Returns this

                                                                                • Parameters

                                                                                  • event: "error"
                                                                                  • listener: (err: Error) => void

                                                                                  Returns this

                                                                                • Parameters

                                                                                  • event: "lookup"
                                                                                  • listener: (err: Error, address: string, family: string | number, host: string) => void

                                                                                  Returns this

                                                                                • Parameters

                                                                                  • event: "ready"
                                                                                  • listener: () => void

                                                                                  Returns this

                                                                                • Parameters

                                                                                  • event: "timeout"
                                                                                  • listener: () => void

                                                                                  Returns this

                                                                                  • Adds a one-time listener function for the event named eventName. The next time eventName is triggered, this listener is removed and then invoked.

                                                                                    server.once('connection', (stream) => {
                                                                                      console.log('Ah, we have our first user!');
                                                                                    });
                                                                                    @@ -700,11 +703,11 @@

                                                                                    Parameters

                                                                                    • event: string
                                                                                    • listener: (...args: any[]) => void

                                                                                      The callback function

                                                                                      -

                                                                                    Returns this

                                                                                    v0.3.0

                                                                                    -

                                                                                  • Parameters

                                                                                    • event: "close"
                                                                                    • listener: (hadError: boolean) => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: "connectionAttempt"
                                                                                    • listener: (ip: string, port: number, family: number) => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: "connectionAttemptFailed"
                                                                                    • listener: (ip: string, port: number, family: number, error: Error) => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: "connectionAttemptTimeout"
                                                                                    • listener: (ip: string, port: number, family: number) => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: "connect"
                                                                                    • listener: () => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: "data"
                                                                                    • listener: (data: Buffer) => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: "drain"
                                                                                    • listener: () => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: "end"
                                                                                    • listener: () => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: "error"
                                                                                    • listener: (err: Error) => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: "lookup"
                                                                                    • listener: (err: Error, address: string, family: string | number, host: string) => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: "ready"
                                                                                    • listener: () => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: "timeout"
                                                                                    • listener: () => void

                                                                                    Returns this

                                                                                  • Pauses the reading of data. That is, 'data' events will not be emitted. +

                                                                                  Returns this

                                                                                  v0.3.0

                                                                                  +

                                                                                • Parameters

                                                                                  • event: "close"
                                                                                  • listener: (hadError: boolean) => void

                                                                                  Returns this

                                                                                • Parameters

                                                                                  • event: "connectionAttempt"
                                                                                  • listener: (ip: string, port: number, family: number) => void

                                                                                  Returns this

                                                                                • Parameters

                                                                                  • event: "connectionAttemptFailed"
                                                                                  • listener: (ip: string, port: number, family: number, error: Error) => void

                                                                                  Returns this

                                                                                • Parameters

                                                                                  • event: "connectionAttemptTimeout"
                                                                                  • listener: (ip: string, port: number, family: number) => void

                                                                                  Returns this

                                                                                • Parameters

                                                                                  • event: "connect"
                                                                                  • listener: () => void

                                                                                  Returns this

                                                                                • Parameters

                                                                                  Returns this

                                                                                • Parameters

                                                                                  • event: "drain"
                                                                                  • listener: () => void

                                                                                  Returns this

                                                                                • Parameters

                                                                                  • event: "end"
                                                                                  • listener: () => void

                                                                                  Returns this

                                                                                • Parameters

                                                                                  • event: "error"
                                                                                  • listener: (err: Error) => void

                                                                                  Returns this

                                                                                • Parameters

                                                                                  • event: "lookup"
                                                                                  • listener: (err: Error, address: string, family: string | number, host: string) => void

                                                                                  Returns this

                                                                                • Parameters

                                                                                  • event: "ready"
                                                                                  • listener: () => void

                                                                                  Returns this

                                                                                • Parameters

                                                                                  • event: "timeout"
                                                                                  • listener: () => void

                                                                                  Returns this

                                                                                  • Pauses the reading of data. That is, 'data' events will not be emitted. Useful to throttle back an upload.

                                                                                    Returns this

                                                                                    The socket itself.

                                                                                    -

                                                                                  • Type Parameters

                                                                                    Parameters

                                                                                    • destination: T
                                                                                    • Optionaloptions: { end?: boolean }

                                                                                    Returns T

                                                                                  • Adds the listener function to the beginning of the listeners array for the +

                                                                                  • Type Parameters

                                                                                    Parameters

                                                                                    • destination: T
                                                                                    • Optionaloptions: { end?: boolean }

                                                                                    Returns T

                                                                                  • Adds the listener function to the beginning of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.

                                                                                    @@ -713,22 +716,22 @@

                                                                                    Returns a reference to the EventEmitter, so that calls can be chained.

                                                                                    Parameters

                                                                                    • event: string
                                                                                    • listener: (...args: any[]) => void

                                                                                      The callback function

                                                                                      -

                                                                                    Returns this

                                                                                    v6.0.0

                                                                                    -

                                                                                  • Parameters

                                                                                    • event: "close"
                                                                                    • listener: (hadError: boolean) => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: "connect"
                                                                                    • listener: () => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: "connectionAttempt"
                                                                                    • listener: (ip: string, port: number, family: number) => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: "connectionAttemptFailed"
                                                                                    • listener: (ip: string, port: number, family: number, error: Error) => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: "connectionAttemptTimeout"
                                                                                    • listener: (ip: string, port: number, family: number) => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: "data"
                                                                                    • listener: (data: Buffer) => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: "drain"
                                                                                    • listener: () => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: "end"
                                                                                    • listener: () => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: "error"
                                                                                    • listener: (err: Error) => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: "lookup"
                                                                                    • listener: (err: Error, address: string, family: string | number, host: string) => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: "ready"
                                                                                    • listener: () => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: "timeout"
                                                                                    • listener: () => void

                                                                                    Returns this

                                                                                  • Adds a one-timelistener function for the event named eventName to the beginning of the listeners array. The next time eventName is triggered, this +

                                                                                  Returns this

                                                                                  v6.0.0

                                                                                  +

                                                                                • Parameters

                                                                                  • event: "close"
                                                                                  • listener: (hadError: boolean) => void

                                                                                  Returns this

                                                                                • Parameters

                                                                                  • event: "connect"
                                                                                  • listener: () => void

                                                                                  Returns this

                                                                                • Parameters

                                                                                  • event: "connectionAttempt"
                                                                                  • listener: (ip: string, port: number, family: number) => void

                                                                                  Returns this

                                                                                • Parameters

                                                                                  • event: "connectionAttemptFailed"
                                                                                  • listener: (ip: string, port: number, family: number, error: Error) => void

                                                                                  Returns this

                                                                                • Parameters

                                                                                  • event: "connectionAttemptTimeout"
                                                                                  • listener: (ip: string, port: number, family: number) => void

                                                                                  Returns this

                                                                                • Parameters

                                                                                  Returns this

                                                                                • Parameters

                                                                                  • event: "drain"
                                                                                  • listener: () => void

                                                                                  Returns this

                                                                                • Parameters

                                                                                  • event: "end"
                                                                                  • listener: () => void

                                                                                  Returns this

                                                                                • Parameters

                                                                                  • event: "error"
                                                                                  • listener: (err: Error) => void

                                                                                  Returns this

                                                                                • Parameters

                                                                                  • event: "lookup"
                                                                                  • listener: (err: Error, address: string, family: string | number, host: string) => void

                                                                                  Returns this

                                                                                • Parameters

                                                                                  • event: "ready"
                                                                                  • listener: () => void

                                                                                  Returns this

                                                                                • Parameters

                                                                                  • event: "timeout"
                                                                                  • listener: () => void

                                                                                  Returns this

                                                                                  • Adds a one-timelistener function for the event named eventName to the beginning of the listeners array. The next time eventName is triggered, this listener is removed, and then invoked.

                                                                                    server.prependOnceListener('connection', (stream) => {
                                                                                      console.log('Ah, we have our first user!');
                                                                                    });

                                                                                    Returns a reference to the EventEmitter, so that calls can be chained.

                                                                                    Parameters

                                                                                    • event: string
                                                                                    • listener: (...args: any[]) => void

                                                                                      The callback function

                                                                                      -

                                                                                    Returns this

                                                                                    v6.0.0

                                                                                    -

                                                                                  • Parameters

                                                                                    • event: "close"
                                                                                    • listener: (hadError: boolean) => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: "connect"
                                                                                    • listener: () => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: "connectionAttempt"
                                                                                    • listener: (ip: string, port: number, family: number) => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: "connectionAttemptFailed"
                                                                                    • listener: (ip: string, port: number, family: number, error: Error) => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: "connectionAttemptTimeout"
                                                                                    • listener: (ip: string, port: number, family: number) => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: "data"
                                                                                    • listener: (data: Buffer) => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: "drain"
                                                                                    • listener: () => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: "end"
                                                                                    • listener: () => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: "error"
                                                                                    • listener: (err: Error) => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: "lookup"
                                                                                    • listener: (err: Error, address: string, family: string | number, host: string) => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: "ready"
                                                                                    • listener: () => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: "timeout"
                                                                                    • listener: () => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    Returns boolean

                                                                                  • Returns a copy of the array of listeners for the event named eventName, +

                                                                                  Returns this

                                                                                  v6.0.0

                                                                                  +

                                                                                • Parameters

                                                                                  • event: "close"
                                                                                  • listener: (hadError: boolean) => void

                                                                                  Returns this

                                                                                • Parameters

                                                                                  • event: "connect"
                                                                                  • listener: () => void

                                                                                  Returns this

                                                                                • Parameters

                                                                                  • event: "connectionAttempt"
                                                                                  • listener: (ip: string, port: number, family: number) => void

                                                                                  Returns this

                                                                                • Parameters

                                                                                  • event: "connectionAttemptFailed"
                                                                                  • listener: (ip: string, port: number, family: number, error: Error) => void

                                                                                  Returns this

                                                                                • Parameters

                                                                                  • event: "connectionAttemptTimeout"
                                                                                  • listener: (ip: string, port: number, family: number) => void

                                                                                  Returns this

                                                                                • Parameters

                                                                                  Returns this

                                                                                • Parameters

                                                                                  • event: "drain"
                                                                                  • listener: () => void

                                                                                  Returns this

                                                                                • Parameters

                                                                                  • event: "end"
                                                                                  • listener: () => void

                                                                                  Returns this

                                                                                • Parameters

                                                                                  • event: "error"
                                                                                  • listener: (err: Error) => void

                                                                                  Returns this

                                                                                • Parameters

                                                                                  • event: "lookup"
                                                                                  • listener: (err: Error, address: string, family: string | number, host: string) => void

                                                                                  Returns this

                                                                                • Parameters

                                                                                  • event: "ready"
                                                                                  • listener: () => void

                                                                                  Returns this

                                                                                • Parameters

                                                                                  • event: "timeout"
                                                                                  • listener: () => void

                                                                                  Returns this

                                                                                  • Parameters

                                                                                    Returns boolean

                                                                                  • Returns a copy of the array of listeners for the event named eventName, including any wrappers (such as those created by .once()).

                                                                                    import { EventEmitter } from 'node:events';
                                                                                    const emitter = new EventEmitter();
                                                                                    emitter.once('log', () => console.log('log once'));

                                                                                    // Returns a new Array with a function `onceWrapper` which has a property
                                                                                    // `listener` which contains the original listener bound above
                                                                                    const listeners = emitter.rawListeners('log');
                                                                                    const logFnWrapper = listeners[0];

                                                                                    // Logs "log once" to the console and does not unbind the `once` event
                                                                                    logFnWrapper.listener();

                                                                                    // Logs "log once" to the console and removes the listener
                                                                                    logFnWrapper();

                                                                                    emitter.on('log', () => console.log('log persistently'));
                                                                                    // Will return a new Array with a single function bound by `.on()` above
                                                                                    const newListeners = emitter.rawListeners('log');

                                                                                    // Logs "log persistently" twice
                                                                                    newListeners[0]();
                                                                                    emitter.emit('log');
                                                                                    -

                                                                                    Type Parameters

                                                                                    • K

                                                                                    Parameters

                                                                                    • eventName: string | symbol

                                                                                    Returns Function[]

                                                                                    v9.4.0

                                                                                    -

                                                                                  • The readable.read() method reads data out of the internal buffer and +

                                                                                    Type Parameters

                                                                                    • K

                                                                                    Parameters

                                                                                    • eventName: string | symbol

                                                                                    Returns Function[]

                                                                                    v9.4.0

                                                                                    +

                                                                                  • The readable.read() method reads data out of the internal buffer and returns it. If no data is available to be read, null is returned. By default, the data is returned as a Buffer object unless an encoding has been specified using the readable.setEncoding() method or the stream is operating @@ -765,7 +768,7 @@

                                                                                    Calling read after the 'end' event has been emitted will return null. No runtime error will be raised.

                                                                                    Parameters

                                                                                    • Optionalsize: number

                                                                                      Optional argument to specify how much data to read.

                                                                                      -

                                                                                    Returns any

                                                                                    v0.9.4

                                                                                    +

                                                                                  Returns any

                                                                                  v0.9.4

                                                                                  • This method calls fn on each chunk of the stream in order, passing it the result from the calculation on the previous element. It returns a promise for the final value of the reduction.

                                                                                    If no initial value is supplied the first chunk of the stream is used as the initial value. @@ -773,30 +776,30 @@

                                                                                    The reducer function iterates the stream element-by-element which means that there is no concurrency parameter or parallelism. To perform a reduce concurrently, you can extract the async function to readable.map method.

                                                                                    Type Parameters

                                                                                    • T = any

                                                                                    Parameters

                                                                                    • fn: (previous: any, data: any, options?: Pick<Stream.ArrayOptions, "signal">) => T

                                                                                      a reducer function to call over every chunk in the stream. Async or not.

                                                                                      -
                                                                                    • Optionalinitial: undefined

                                                                                      the initial value to use in the reduction.

                                                                                      -
                                                                                    • Optionaloptions: Pick<Stream.ArrayOptions, "signal">

                                                                                    Returns Promise<T>

                                                                                    a promise for the final value of the reduction.

                                                                                    -

                                                                                    v17.5.0

                                                                                    -

                                                                                  • This method calls fn on each chunk of the stream in order, passing it the result from the calculation +

                                                                                  • Optionalinitial: undefined

                                                                                    the initial value to use in the reduction.

                                                                                    +
                                                                                  • Optionaloptions: Pick<Stream.ArrayOptions, "signal">

                                                                                  Returns Promise<T>

                                                                                  a promise for the final value of the reduction.

                                                                                  +

                                                                                  v17.5.0

                                                                                  +

                                                                                • This method calls fn on each chunk of the stream in order, passing it the result from the calculation on the previous element. It returns a promise for the final value of the reduction.

                                                                                  If no initial value is supplied the first chunk of the stream is used as the initial value. If the stream is empty, the promise is rejected with a TypeError with the ERR_INVALID_ARGS code property.

                                                                                  The reducer function iterates the stream element-by-element which means that there is no concurrency parameter or parallelism. To perform a reduce concurrently, you can extract the async function to readable.map method.

                                                                                  Type Parameters

                                                                                  • T = any

                                                                                  Parameters

                                                                                  • fn: (previous: T, data: any, options?: Pick<Stream.ArrayOptions, "signal">) => T

                                                                                    a reducer function to call over every chunk in the stream. Async or not.

                                                                                    -
                                                                                  • initial: T

                                                                                    the initial value to use in the reduction.

                                                                                    -
                                                                                  • Optionaloptions: Pick<Stream.ArrayOptions, "signal">

                                                                                  Returns Promise<T>

                                                                                  a promise for the final value of the reduction.

                                                                                  -

                                                                                  v17.5.0

                                                                                  -

                                                                                  • Opposite of unref(), calling ref() on a previously unrefed socket will not let the program exit if it's the only socket left (the default behavior). +

                                                                                  • initial: T

                                                                                    the initial value to use in the reduction.

                                                                                    +
                                                                                  • Optionaloptions: Pick<Stream.ArrayOptions, "signal">

                                                                                  Returns Promise<T>

                                                                                  a promise for the final value of the reduction.

                                                                                  +

                                                                                  v17.5.0

                                                                                  +

                                                                                  • Opposite of unref(), calling ref() on a previously unrefed socket will not let the program exit if it's the only socket left (the default behavior). If the socket is refed calling ref again will have no effect.

                                                                                    Returns this

                                                                                    The socket itself.

                                                                                    -

                                                                                    v0.9.1

                                                                                    -

                                                                                  • Removes all listeners, or those of the specified eventName.

                                                                                    +

                                                                                    v0.9.1

                                                                                    +

                                                                                  • Removes all listeners, or those of the specified eventName.

                                                                                    It is bad practice to remove listeners added elsewhere in the code, particularly when the EventEmitter instance was created by some other component or module (e.g. sockets or file streams).

                                                                                    Returns a reference to the EventEmitter, so that calls can be chained.

                                                                                    -

                                                                                    Parameters

                                                                                    • OptionaleventName: string | symbol

                                                                                    Returns this

                                                                                    v0.1.26

                                                                                    -

                                                                                  • Removes the specified listener from the listener array for the event named eventName.

                                                                                    +

                                                                                    Parameters

                                                                                    • OptionaleventName: string | symbol

                                                                                    Returns this

                                                                                    v0.1.26

                                                                                    +

                                                                                  • Removes the specified listener from the listener array for the event named eventName.

                                                                                    const callback = (stream) => {
                                                                                      console.log('someone connected!');
                                                                                    };
                                                                                    server.on('connection', callback);
                                                                                    // ...
                                                                                    server.removeListener('connection', callback);
                                                                                    @@ -822,21 +825,21 @@

                                                                                    Returns a reference to the EventEmitter, so that calls can be chained.

                                                                                    -

                                                                                    Parameters

                                                                                    • event: "close"
                                                                                    • listener: () => void

                                                                                    Returns this

                                                                                    v0.1.26

                                                                                    -

                                                                                  • Parameters

                                                                                    • event: "data"
                                                                                    • listener: (chunk: any) => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: "drain"
                                                                                    • listener: () => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: "end"
                                                                                    • listener: () => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: "error"
                                                                                    • listener: (err: Error) => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: "finish"
                                                                                    • listener: () => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: "pause"
                                                                                    • listener: () => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: "pipe"
                                                                                    • listener: (src: Readable) => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: "readable"
                                                                                    • listener: () => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: "resume"
                                                                                    • listener: () => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: "unpipe"
                                                                                    • listener: (src: Readable) => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: string | symbol
                                                                                    • listener: (...args: any[]) => void

                                                                                    Returns this

                                                                                  • Close the TCP connection by sending an RST packet and destroy the stream. +

                                                                                    Parameters

                                                                                    • event: "close"
                                                                                    • listener: () => void

                                                                                    Returns this

                                                                                    v0.1.26

                                                                                    +

                                                                                  • Parameters

                                                                                    • event: "data"
                                                                                    • listener: (chunk: any) => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: "drain"
                                                                                    • listener: () => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: "end"
                                                                                    • listener: () => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: "error"
                                                                                    • listener: (err: Error) => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: "finish"
                                                                                    • listener: () => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: "pause"
                                                                                    • listener: () => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: "pipe"
                                                                                    • listener: (src: Readable) => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: "readable"
                                                                                    • listener: () => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: "resume"
                                                                                    • listener: () => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: "unpipe"
                                                                                    • listener: (src: Readable) => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: string | symbol
                                                                                    • listener: (...args: any[]) => void

                                                                                    Returns this

                                                                                  • Close the TCP connection by sending an RST packet and destroy the stream. If this TCP socket is in connecting status, it will send an RST packet and destroy this TCP socket once it is connected. Otherwise, it will call socket.destroy with an ERR_SOCKET_CLOSED Error. If this is not a TCP socket (for example, a pipe), calling this method will immediately throw an ERR_INVALID_HANDLE_TYPE Error.

                                                                                    -

                                                                                    Returns this

                                                                                    v18.3.0, v16.17.0

                                                                                    -

                                                                                  • Resumes reading after a call to socket.pause().

                                                                                    +

                                                                                    Returns this

                                                                                    v18.3.0, v16.17.0

                                                                                    +

                                                                                  • Resumes reading after a call to socket.pause().

                                                                                    Returns this

                                                                                    The socket itself.

                                                                                    -

                                                                                  • The writable.setDefaultEncoding() method sets the default encoding for a Writable stream.

                                                                                    +

                                                                                  • The writable.setDefaultEncoding() method sets the default encoding for a Writable stream.

                                                                                    Parameters

                                                                                    Returns this

                                                                                    v0.11.15

                                                                                    -

                                                                                  • Set the encoding for the socket as a Readable Stream. See readable.setEncoding() for more information.

                                                                                    +

                                                                                  Returns this

                                                                                  v0.11.15

                                                                                  +

                                                                                  • Set the encoding for the socket as a Readable Stream. See readable.setEncoding() for more information.

                                                                                    Parameters

                                                                                    Returns this

                                                                                    The socket itself.

                                                                                    -

                                                                                    v0.1.90

                                                                                    -

                                                                                  • Enable/disable keep-alive functionality, and optionally set the initial +

                                                                                    v0.1.90

                                                                                    +

                                                                                  • Enable/disable keep-alive functionality, and optionally set the initial delay before the first keepalive probe is sent on an idle socket.

                                                                                    Set initialDelay (in milliseconds) to set the delay between the last data packet received and the first keepalive probe. Setting 0 forinitialDelay will leave the value unchanged from the default @@ -848,24 +851,24 @@

                                                                                  • TCP_KEEPCNT=10
                                                                                  • TCP_KEEPINTVL=1
                                                                                  -

                                                                                  Parameters

                                                                                  • Optionalenable: boolean
                                                                                  • OptionalinitialDelay: number

                                                                                  Returns this

                                                                                  The socket itself.

                                                                                  -

                                                                                  v0.1.92

                                                                                  -

                                                                                  • By default EventEmitters will print a warning if more than 10 listeners are +

                                                                                    Parameters

                                                                                    • Optionalenable: boolean
                                                                                    • OptionalinitialDelay: number

                                                                                    Returns this

                                                                                    The socket itself.

                                                                                    +

                                                                                    v0.1.92

                                                                                    +

                                                                                  • By default EventEmitters will print a warning if more than 10 listeners are added for a particular event. This is a useful default that helps finding memory leaks. The emitter.setMaxListeners() method allows the limit to be modified for this specific EventEmitter instance. The value can be set to Infinity (or 0) to indicate an unlimited number of listeners.

                                                                                    Returns a reference to the EventEmitter, so that calls can be chained.

                                                                                    -

                                                                                    Parameters

                                                                                    • n: number

                                                                                    Returns this

                                                                                    v0.3.5

                                                                                    -

                                                                                  • Enable/disable the use of Nagle's algorithm.

                                                                                    +

                                                                                    Parameters

                                                                                    • n: number

                                                                                    Returns this

                                                                                    v0.3.5

                                                                                    +

                                                                                  • Enable/disable the use of Nagle's algorithm.

                                                                                    When a TCP connection is created, it will have Nagle's algorithm enabled.

                                                                                    Nagle's algorithm delays data before it is sent via the network. It attempts to optimize throughput at the expense of latency.

                                                                                    Passing true for noDelay or not passing an argument will disable Nagle's algorithm for the socket. Passing false for noDelay will enable Nagle's algorithm.

                                                                                    -

                                                                                    Parameters

                                                                                    • OptionalnoDelay: boolean

                                                                                    Returns this

                                                                                    The socket itself.

                                                                                    -

                                                                                    v0.1.90

                                                                                    -

                                                                                  • Sets the socket to timeout after timeout milliseconds of inactivity on +

                                                                                    Parameters

                                                                                    • OptionalnoDelay: boolean

                                                                                    Returns this

                                                                                    The socket itself.

                                                                                    +

                                                                                    v0.1.90

                                                                                    +

                                                                                  • Sets the socket to timeout after timeout milliseconds of inactivity on the socket. By default net.Socket do not have a timeout.

                                                                                    When an idle timeout is triggered the socket will receive a 'timeout' event but the connection will not be severed. The user must manually call socket.end() or socket.destroy() to end the connection.

                                                                                    @@ -875,23 +878,23 @@

                                                                                    If timeout is 0, then the existing idle timeout is disabled.

                                                                                    The optional callback parameter will be added as a one-time listener for the 'timeout' event.

                                                                                    Parameters

                                                                                    • timeout: number
                                                                                    • Optionalcallback: () => void

                                                                                    Returns this

                                                                                    The socket itself.

                                                                                    -

                                                                                    v0.1.90

                                                                                    -

                                                                                  • This method is similar to Array.prototype.some and calls fn on each chunk in the stream +

                                                                                    v0.1.90

                                                                                    +

                                                                                  • This method is similar to Array.prototype.some and calls fn on each chunk in the stream until the awaited return value is true (or any truthy value). Once an fn call on a chunk awaited return value is truthy, the stream is destroyed and the promise is fulfilled with true. If none of the fn calls on the chunks return a truthy value, the promise is fulfilled with false.

                                                                                    Parameters

                                                                                    • fn: (
                                                                                          data: any,
                                                                                          options?: Pick<Stream.ArrayOptions, "signal">,
                                                                                      ) => boolean | Promise<boolean>

                                                                                      a function to call on each chunk of the stream. Async or not.

                                                                                      -
                                                                                    • Optionaloptions: Stream.ArrayOptions

                                                                                    Returns Promise<boolean>

                                                                                    a promise evaluating to true if fn returned a truthy value for at least one of the chunks.

                                                                                    -

                                                                                    v17.5.0

                                                                                    -

                                                                                  Returns Promise<boolean>

                                                                                  a promise evaluating to true if fn returned a truthy value for at least one of the chunks.

                                                                                  v17.5.0

                                                                                  +

                                                                                  • This method returns a new stream with the first limit chunks.

                                                                                    +

                                                                                    Parameters

                                                                                    • limit: number

                                                                                      the number of chunks to take from the readable.

                                                                                      +
                                                                                    • Optionaloptions: Pick<Stream.ArrayOptions, "signal">

                                                                                    Returns Readable

                                                                                    a stream with limit chunks taken.

                                                                                    +

                                                                                    v17.5.0

                                                                                  • This method allows easily obtaining the contents of a stream.

                                                                                    As this method reads the entire stream into memory, it negates the benefits of streams. It's intended for interoperability and convenience, not as the primary way to consume streams.

                                                                                    Parameters

                                                                                    Returns Promise<any[]>

                                                                                    a promise containing an array with the contents of the stream.

                                                                                    -

                                                                                    v17.5.0

                                                                                    +

                                                                                    v17.5.0

                                                                                  • The writable.uncork() method flushes all data buffered since cork was called.

                                                                                    When using writable.cork() and writable.uncork() to manage the buffering of writes to a stream, defer calls to writable.uncork() using process.nextTick(). Doing so allows batching of all writable.write() calls that occur within a given Node.js event @@ -906,8 +909,8 @@

                                                                                    See also: writable.cork().

                                                                                    -

                                                                                    Returns void

                                                                                    v0.11.2

                                                                                    -

                                                                                  • The readable.unpipe() method detaches a Writable stream previously attached +

                                                                                    Returns void

                                                                                    v0.11.2

                                                                                    +

                                                                                  • The readable.unpipe() method detaches a Writable stream previously attached using the pipe method.

                                                                                    If the destination is not specified, then all pipes are detached.

                                                                                    If the destination is specified, but no pipe is set up for it, then @@ -916,12 +919,12 @@

                                                                                    Parameters

                                                                                    • Optionaldestination: WritableStream

                                                                                      Optional specific stream to unpipe

                                                                                      -

                                                                                    Returns this

                                                                                    v0.9.4

                                                                                    -

                                                                                  • Calling unref() on a socket will allow the program to exit if this is the only +

                                                                                  Returns this

                                                                                  v0.9.4

                                                                                  +

                                                                                  • Calling unref() on a socket will allow the program to exit if this is the only active socket in the event system. If the socket is already unrefed callingunref() again will have no effect.

                                                                                    Returns this

                                                                                    The socket itself.

                                                                                    -

                                                                                    v0.9.1

                                                                                    -

                                                                                  • Passing chunk as null signals the end of the stream (EOF) and behaves the +

                                                                                    v0.9.1

                                                                                    +

                                                                                  • Passing chunk as null signals the end of the stream (EOF) and behaves the same as readable.push(null), after which no more data can be written. The EOF signal is put at the end of the buffer and any buffered data will still be flushed.

                                                                                    @@ -945,8 +948,8 @@ process of performing a read.

                                                                                    Parameters

                                                                                    • chunk: any

                                                                                      Chunk of data to unshift onto the read queue. For streams not operating in object mode, chunk must be a {string}, {Buffer}, {TypedArray}, {DataView} or null. For object mode streams, chunk may be any JavaScript value.

                                                                                      -
                                                                                    • Optionalencoding: BufferEncoding

                                                                                      Encoding of string chunks. Must be a valid Buffer encoding, such as 'utf8' or 'ascii'.

                                                                                      -

                                                                                    Returns void

                                                                                    v0.9.11

                                                                                    +
                                                                                  • Optionalencoding: BufferEncoding

                                                                                    Encoding of string chunks. Must be a valid Buffer encoding, such as 'utf8' or 'ascii'.

                                                                                    +

                                                                                  Returns void

                                                                                  v0.9.11

                                                                                  • Prior to Node.js 0.10, streams did not implement the entire node:stream module API as it is currently defined. (See Compatibility for more information.)

                                                                                    When using an older Node.js library that emits 'data' events and has a pause method that is advisory only, the readable.wrap() method can be used to create a Readable @@ -959,8 +962,8 @@

                                                                                    Parameters

                                                                                    Returns this

                                                                                    v0.9.4

                                                                                    -

                                                                                  • Sends data on the socket. The second parameter specifies the encoding in the +

                                                                                  Returns this

                                                                                  v0.9.4

                                                                                  +

                                                                                  • Sends data on the socket. The second parameter specifies the encoding in the case of a string. It defaults to UTF8 encoding.

                                                                                    Returns true if the entire data was flushed successfully to the kernel buffer. Returns false if all or part of the data was queued in user memory.'drain' will be emitted when the buffer is again free.

                                                                                    @@ -968,8 +971,8 @@ written out, which may not be immediately.

                                                                                    See Writable stream write() method for more information.

                                                                                    -

                                                                                    Parameters

                                                                                    • buffer: string | Uint8Array<ArrayBufferLike>
                                                                                    • Optionalcb: (err?: Error) => void

                                                                                    Returns boolean

                                                                                    v0.1.90

                                                                                    -

                                                                                  • Sends data on the socket. The second parameter specifies the encoding in the +

                                                                                    Parameters

                                                                                    • buffer: string | Uint8Array<ArrayBufferLike>
                                                                                    • Optionalcb: (err?: Error) => void

                                                                                    Returns boolean

                                                                                    v0.1.90

                                                                                    +

                                                                                  • Sends data on the socket. The second parameter specifies the encoding in the case of a string. It defaults to UTF8 encoding.

                                                                                    Returns true if the entire data was flushed successfully to the kernel buffer. Returns false if all or part of the data was queued in user memory.'drain' will be emitted when the buffer is again free.

                                                                                    @@ -978,8 +981,8 @@

                                                                                    See Writable stream write() method for more information.

                                                                                    Parameters

                                                                                    Returns boolean

                                                                                    v0.1.90

                                                                                    -

                                                                                  • Listens once to the abort event on the provided signal.

                                                                                    +
                                                                                  • Optionalcb: (err?: Error) => void

                                                                                  Returns boolean

                                                                                  v0.1.90

                                                                                  +

                                                                                  • Listens once to the abort event on the provided signal.

                                                                                    Listening to the abort event on abort signals is unsafe and may lead to resource leaks since another third party with the signal can call e.stopImmediatePropagation(). Unfortunately Node.js cannot change @@ -993,8 +996,8 @@

                                                                                    Parameters

                                                                                    Returns Disposable

                                                                                    Disposable that removes the abort listener.

                                                                                    -

                                                                                    v20.5.0

                                                                                    -

                                                                                  • A utility method for creating duplex streams.

                                                                                    +

                                                                                    v20.5.0

                                                                                    +

                                                                                  • A utility method for creating duplex streams.

                                                                                    • Stream converts writable stream into writable Duplex and readable stream to Duplex.
                                                                                      • @@ -1012,10 +1015,10 @@ Duplex will write to the writable and read from the readable.
                                                                                    • Promise converts into readable Duplex. Value null is ignored.
                                                                                    -

                                                                                    Parameters

                                                                                    Returns Duplex

                                                                                    v16.8.0

                                                                                    -

                                                                                  • A utility method for creating a Duplex from a web ReadableStream and WritableStream.

                                                                                    -

                                                                                    Parameters

                                                                                    • duplexStream: { readable: ReadableStream; writable: WritableStream }
                                                                                    • Optionaloptions: Pick<
                                                                                          DuplexOptions,
                                                                                          | "allowHalfOpen"
                                                                                          | "decodeStrings"
                                                                                          | "encoding"
                                                                                          | "highWaterMark"
                                                                                          | "objectMode"
                                                                                          | "signal",
                                                                                      >

                                                                                    Returns Duplex

                                                                                    v17.0.0

                                                                                    -

                                                                                  • Returns a copy of the array of listeners for the event named eventName.

                                                                                    +

                                                                                    Parameters

                                                                                    Returns Duplex

                                                                                    v16.8.0

                                                                                    +

                                                                                  • A utility method for creating a Duplex from a web ReadableStream and WritableStream.

                                                                                    +

                                                                                    Parameters

                                                                                    • duplexStream: { readable: ReadableStream; writable: WritableStream }
                                                                                    • Optionaloptions: Pick<
                                                                                          DuplexOptions,
                                                                                          | "allowHalfOpen"
                                                                                          | "decodeStrings"
                                                                                          | "encoding"
                                                                                          | "highWaterMark"
                                                                                          | "objectMode"
                                                                                          | "signal",
                                                                                      >

                                                                                    Returns Duplex

                                                                                    v17.0.0

                                                                                    +

                                                                                  • Returns a copy of the array of listeners for the event named eventName.

                                                                                    For EventEmitters this behaves exactly the same as calling .listeners on the emitter.

                                                                                    For EventTargets this is the only way to get the event listeners for the @@ -1023,8 +1026,8 @@ 

                                                                                    import { getEventListeners, EventEmitter } from 'node:events';

                                                                                    {
                                                                                      const ee = new EventEmitter();
                                                                                      const listener = () => console.log('Events are fun');
                                                                                      ee.on('foo', listener);
                                                                                      console.log(getEventListeners(ee, 'foo')); // [ [Function: listener] ]
                                                                                    }
                                                                                    {
                                                                                      const et = new EventTarget();
                                                                                      const listener = () => console.log('Events are fun');
                                                                                      et.addEventListener('foo', listener);
                                                                                      console.log(getEventListeners(et, 'foo')); // [ [Function: listener] ]
                                                                                    }
                                                                                    -

                                                                                    Parameters

                                                                                    Returns Function[]

                                                                                    v15.2.0, v14.17.0

                                                                                    -

                                                                                  • Returns the currently set max amount of listeners.

                                                                                    For EventEmitters this behaves exactly the same as calling .getMaxListeners on the emitter.

                                                                                    For EventTargets this is the only way to get the max event listeners for the @@ -1033,16 +1036,16 @@ 

                                                                                    import { getMaxListeners, setMaxListeners, EventEmitter } from 'node:events';

                                                                                    {
                                                                                      const ee = new EventEmitter();
                                                                                      console.log(getMaxListeners(ee)); // 10
                                                                                      setMaxListeners(11, ee);
                                                                                      console.log(getMaxListeners(ee)); // 11
                                                                                    }
                                                                                    {
                                                                                      const et = new EventTarget();
                                                                                      console.log(getMaxListeners(et)); // 10
                                                                                      setMaxListeners(11, et);
                                                                                      console.log(getMaxListeners(et)); // 11
                                                                                    }
                                                                                    -

                                                                                    Parameters

                                                                                    Returns number

                                                                                    v19.9.0

                                                                                    -

                                                                                  • A class method that returns the number of listeners for the given eventName registered on the given emitter.

                                                                                    +

                                                                                    Parameters

                                                                                    Returns number

                                                                                    v19.9.0

                                                                                    +

                                                                                  • A class method that returns the number of listeners for the given eventName registered on the given emitter.

                                                                                    import { EventEmitter, listenerCount } from 'node:events';

                                                                                    const myEmitter = new EventEmitter();
                                                                                    myEmitter.on('event', () => {});
                                                                                    myEmitter.on('event', () => {});
                                                                                    console.log(listenerCount(myEmitter, 'event'));
                                                                                    // Prints: 2

                                                                                    Parameters

                                                                                    • emitter: EventEmitter

                                                                                      The emitter to query

                                                                                      -
                                                                                    • eventName: string | symbol

                                                                                      The event name

                                                                                      -

                                                                                    Returns number

                                                                                    v0.9.12

                                                                                    +
                                                                                  • eventName: string | symbol

                                                                                    The event name

                                                                                    +

                                                                                  Returns number

                                                                                  v0.9.12

                                                                                  Since v3.2.0 - Use listenerCount instead.

                                                                                  -
                                                                                  • import { on, EventEmitter } from 'node:events';
                                                                                    import process from 'node:process';

                                                                                    const ee = new EventEmitter();

                                                                                    // Emit later on
                                                                                    process.nextTick(() => {
                                                                                      ee.emit('foo', 'bar');
                                                                                      ee.emit('foo', 42);
                                                                                    });

                                                                                    for await (const event of on(ee, 'foo')) {
                                                                                      // The execution of this inner block is synchronous and it
                                                                                      // processes one event at a time (even with await). Do not use
                                                                                      // if concurrent execution is required.
                                                                                      console.log(event); // prints ['bar'] [42]
                                                                                    }
                                                                                    // Unreachable here
+
                                                                                  • import { on, EventEmitter } from 'node:events';
                                                                                    import process from 'node:process';

                                                                                    const ee = new EventEmitter();

                                                                                    // Emit later on
                                                                                    process.nextTick(() => {
                                                                                      ee.emit('foo', 'bar');
                                                                                      ee.emit('foo', 42);
                                                                                    });

                                                                                    for await (const event of on(ee, 'foo')) {
                                                                                      // The execution of this inner block is synchronous and it
                                                                                      // processes one event at a time (even with await). Do not use
                                                                                      // if concurrent execution is required.
                                                                                      console.log(event); // prints ['bar'] [42]
                                                                                    }
                                                                                    // Unreachable here

                                                                                    Returns an AsyncIterator that iterates eventName events. It will throw @@ -1058,8 +1061,8 @@

                                                                                    Parameters

                                                                                    Returns AsyncIterator<any[]>

                                                                                    An AsyncIterator that iterates eventName events emitted by the emitter

                                                                                    -

                                                                                    v13.6.0, v12.16.0

                                                                                    -
                                                                                  • import { on, EventEmitter } from 'node:events';
                                                                                    import process from 'node:process';

                                                                                    const ee = new EventEmitter();

                                                                                    // Emit later on
                                                                                    process.nextTick(() => {
                                                                                      ee.emit('foo', 'bar');
                                                                                      ee.emit('foo', 42);
                                                                                    });

                                                                                    for await (const event of on(ee, 'foo')) {
                                                                                      // The execution of this inner block is synchronous and it
                                                                                      // processes one event at a time (even with await). Do not use
                                                                                      // if concurrent execution is required.
                                                                                      console.log(event); // prints ['bar'] [42]
                                                                                    }
                                                                                    // Unreachable here
+
                                                                                    v13.6.0, v12.16.0
                                                                                    
+
                                                                                  • import { on, EventEmitter } from 'node:events';
                                                                                    import process from 'node:process';

                                                                                    const ee = new EventEmitter();

                                                                                    // Emit later on
                                                                                    process.nextTick(() => {
                                                                                      ee.emit('foo', 'bar');
                                                                                      ee.emit('foo', 42);
                                                                                    });

                                                                                    for await (const event of on(ee, 'foo')) {
                                                                                      // The execution of this inner block is synchronous and it
                                                                                      // processes one event at a time (even with await). Do not use
                                                                                      // if concurrent execution is required.
                                                                                      console.log(event); // prints ['bar'] [42]
                                                                                    }
                                                                                    // Unreachable here

                                                                                    Returns an AsyncIterator that iterates eventName events. It will throw @@ -1075,8 +1078,8 @@

                                                                                    Parameters

                                                                                    Returns AsyncIterator<any[]>

                                                                                    An AsyncIterator that iterates eventName events emitted by the emitter

                                                                                    -

                                                                                    v13.6.0, v12.16.0

                                                                                    -

                                                                                  • Creates a Promise that is fulfilled when the EventEmitter emits the given +

                                                                                    v13.6.0, v12.16.0

                                                                                    +

                                                                                  • Creates a Promise that is fulfilled when the EventEmitter emits the given event or that is rejected if the EventEmitter emits 'error' while waiting. The Promise will resolve with an array of all the arguments emitted to the given event.

                                                                                    @@ -1095,8 +1098,8 @@ 
                                                                                    import { EventEmitter, once } from 'node:events';

                                                                                    const ee = new EventEmitter();
                                                                                    const ac = new AbortController();

                                                                                    async function foo(emitter, event, signal) {
                                                                                      try {
                                                                                        await once(emitter, event, { signal });
                                                                                        console.log('event emitted!');
                                                                                      } catch (error) {
                                                                                        if (error.name === 'AbortError') {
                                                                                          console.error('Waiting for the event was canceled!');
                                                                                        } else {
                                                                                          console.error('There was an error', error.message);
                                                                                        }
                                                                                      }
                                                                                    }

                                                                                    foo(ee, 'foo', ac.signal);
                                                                                    ac.abort(); // Abort waiting for the event
                                                                                    ee.emit('foo'); // Prints: Waiting for the event was canceled!
                                                                                    -

                                                                                    Parameters

                                                                                    Returns Promise<any[]>

                                                                                    v11.13.0, v10.16.0

                                                                                    -

                                                                                  • Creates a Promise that is fulfilled when the EventEmitter emits the given +

                                                                                    Parameters

                                                                                    Returns Promise<any[]>

                                                                                    v11.13.0, v10.16.0

                                                                                    +

                                                                                  • Creates a Promise that is fulfilled when the EventEmitter emits the given event or that is rejected if the EventEmitter emits 'error' while waiting. The Promise will resolve with an array of all the arguments emitted to the given event.

                                                                                    @@ -1115,14 +1118,14 @@ 
                                                                                    import { EventEmitter, once } from 'node:events';

                                                                                    const ee = new EventEmitter();
                                                                                    const ac = new AbortController();

                                                                                    async function foo(emitter, event, signal) {
                                                                                      try {
                                                                                        await once(emitter, event, { signal });
                                                                                        console.log('event emitted!');
                                                                                      } catch (error) {
                                                                                        if (error.name === 'AbortError') {
                                                                                          console.error('Waiting for the event was canceled!');
                                                                                        } else {
                                                                                          console.error('There was an error', error.message);
                                                                                        }
                                                                                      }
                                                                                    }

                                                                                    foo(ee, 'foo', ac.signal);
                                                                                    ac.abort(); // Abort waiting for the event
                                                                                    ee.emit('foo'); // Prints: Waiting for the event was canceled!
                                                                                    -

                                                                                    Parameters

                                                                                    Returns Promise<any[]>

                                                                                    v11.13.0, v10.16.0

                                                                                    -
                                                                                  • import { setMaxListeners, EventEmitter } from 'node:events';

                                                                                    const target = new EventTarget();
                                                                                    const emitter = new EventEmitter();

                                                                                    setMaxListeners(5, target, emitter);
+

                                                                                    Parameters

                                                                                    Returns Promise<any[]>

                                                                                    v11.13.0, v10.16.0

                                                                                    +
                                                                                  • import { setMaxListeners, EventEmitter } from 'node:events';

                                                                                    const target = new EventTarget();
                                                                                    const emitter = new EventEmitter();

                                                                                    setMaxListeners(5, target, emitter);

                                                                                    Parameters

                                                                                    • Optionaln: number

                                                                                      A non-negative number. The maximum number of listeners per EventTarget event.

                                                                                      -
                                                                                    • ...eventTargets: (EventEmitter<DefaultEventMap> | EventTarget)[]

                                                                                      Zero or more {EventTarget} or {EventEmitter} instances. If none are specified, n is set as the default max for all newly created {EventTarget} and {EventEmitter} +

                                                                                    • ...eventTargets: (EventEmitter<DefaultEventMap> | EventTarget)[]

                                                                                      Zero or more {EventTarget} or {EventEmitter} instances. If none are specified, n is set as the default max for all newly created {EventTarget} and {EventEmitter} objects.

                                                                                      -

                                                                                    Returns void

                                                                                    v15.4.0

                                                                                    -

                                                                                  Settings

                                                                                  Member Visibility

                                                                                  On This Page

                                                                                  Constructors
                                                                                  Properties
                                                                                  Methods
                                                                                  +

                                                                                  Returns void

                                                                                  v15.4.0

                                                                                  +

                                                                                  Settings

                                                                                  Member Visibility

                                                                                  On This Page

                                                                                  Constructors
                                                                                  Properties
                                                                                  Methods
                                                                                  diff --git a/docs/classes/_internal_.SocketAddress.html b/docs/classes/_internal_.SocketAddress.html index d4e759b6..20f94b49 100644 --- a/docs/classes/_internal_.SocketAddress.html +++ b/docs/classes/_internal_.SocketAddress.html @@ -1,19 +1,19 @@ SocketAddress | ts-lambda-api - v2.5.2
                                                                                  ts-lambda-api - v2.5.2
                                                                                    Preparing search index...

                                                                                    Class SocketAddress

                                                                                    v15.14.0, v14.18.0

                                                                                    -
                                                                                    Index

                                                                                    Constructors

                                                                                    constructor +
                                                                                    Index

                                                                                    Constructors

                                                                                    constructor

                                                                                    Properties

                                                                                    address family flowlabel port

                                                                                    Methods

                                                                                    parse -

                                                                                    Constructors

                                                                                    Properties

                                                                                    address: string

                                                                                    Either 'ipv4' or 'ipv6'.

                                                                                    +

                                                                                    Constructors

                                                                                    Properties

                                                                                    address: string

                                                                                    Either 'ipv4' or 'ipv6'.

                                                                                    v15.14.0, v14.18.0

                                                                                    -
                                                                                    family: IPVersion

                                                                                    Either 'ipv4' or 'ipv6'.

                                                                                    +
                                                                                    family: IPVersion

                                                                                    Either 'ipv4' or 'ipv6'.

                                                                                    v15.14.0, v14.18.0

                                                                                    -
                                                                                    flowlabel: number

                                                                                    v15.14.0, v14.18.0

                                                                                    -
                                                                                    port: number

                                                                                    v15.14.0, v14.18.0

                                                                                    -

                                                                                    Methods

                                                                                    • Parameters

                                                                                      • input: string

                                                                                        An input string containing an IP address and optional port, +

                                                                                    flowlabel: number

                                                                                    v15.14.0, v14.18.0

                                                                                    +
                                                                                    port: number

                                                                                    v15.14.0, v14.18.0

                                                                                    +

                                                                                    Methods

                                                                                    • Parameters

                                                                                      • input: string

                                                                                        An input string containing an IP address and optional port, e.g. 123.1.2.3:1234 or [1::1]:1234.

                                                                                        -

                                                                                      Returns SocketAddress

                                                                                      Returns a SocketAddress if parsing was successful. +

                                                                                    Returns SocketAddress

                                                                                    Returns a SocketAddress if parsing was successful. Otherwise returns undefined.

                                                                                    v22.13.0

                                                                                    -

                                                                                    Settings

                                                                                    Member Visibility

                                                                                    On This Page

                                                                                    Constructors
                                                                                    Properties
                                                                                    Methods
                                                                                    +

                                                                                    Settings

                                                                                    Member Visibility

                                                                                    On This Page

                                                                                    Constructors
                                                                                    Properties
                                                                                    Methods
                                                                                    diff --git a/docs/classes/_internal_.Stream.Duplex.html b/docs/classes/_internal_.Stream.Duplex.html index 5f93fd37..d89e7fb0 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 @@ -97,13 +97,13 @@ once setMaxListeners toWeb -

                                                                                    Constructors

                                                                                    Properties

                                                                                    allowHalfOpen: boolean

                                                                                    If false then the stream will automatically end the writable side when the +

                                                                                    Constructors

                                                                                    Properties

                                                                                    allowHalfOpen: boolean

                                                                                    If false then the stream will automatically end the writable side when the readable side ends. Set initially by the allowHalfOpen constructor option, which defaults to true.

                                                                                    This can be changed manually to change the half-open behavior of an existing Duplex stream instance, but must be changed before the 'end' event is emitted.

                                                                                    v0.9.4

                                                                                    -
                                                                                    closed: boolean

                                                                                    Is true after 'close' has been emitted.

                                                                                    +
                                                                                    closed: boolean

                                                                                    Is true after 'close' has been emitted.

                                                                                    v18.0.0

                                                                                    destroyed: boolean

                                                                                    Is true after readable.destroy() has been called.

                                                                                    v8.0.0

                                                                                    @@ -134,33 +134,33 @@
                                                                                    writable: boolean

                                                                                    Is true if it is safe to call writable.write(), which means the stream has not been destroyed, errored, or ended.

                                                                                    v11.4.0

                                                                                    -
                                                                                    writableAborted: boolean

                                                                                    Returns whether the stream was destroyed or errored before emitting 'finish'.

                                                                                    +
                                                                                    writableAborted: boolean

                                                                                    Returns whether the stream was destroyed or errored before emitting 'finish'.

                                                                                    v18.0.0, v16.17.0

                                                                                    -
                                                                                    writableCorked: number

                                                                                    Number of times writable.uncork() needs to be +

                                                                                    writableCorked: number

                                                                                    Number of times writable.uncork() needs to be called in order to fully uncork the stream.

                                                                                    v13.2.0, v12.16.0

                                                                                    -
                                                                                    writableEnded: boolean

                                                                                    Is true after writable.end() has been called. This property +

                                                                                    writableEnded: boolean

                                                                                    Is true after writable.end() has been called. This property does not indicate whether the data has been flushed, for this use writable.writableFinished instead.

                                                                                    v12.9.0

                                                                                    -
                                                                                    writableFinished: boolean

                                                                                    Is set to true immediately before the 'finish' event is emitted.

                                                                                    +
                                                                                    writableFinished: boolean

                                                                                    Is set to true immediately before the 'finish' event is emitted.

                                                                                    v12.6.0

                                                                                    -
                                                                                    writableHighWaterMark: number

                                                                                    Return the value of highWaterMark passed when creating this Writable.

                                                                                    +
                                                                                    writableHighWaterMark: number

                                                                                    Return the value of highWaterMark passed when creating this Writable.

                                                                                    v9.3.0

                                                                                    -
                                                                                    writableLength: number

                                                                                    This property contains the number of bytes (or objects) in the queue +

                                                                                    writableLength: number

                                                                                    This property contains the number of bytes (or objects) in the queue ready to be written. The value provides introspection data regarding the status of the highWaterMark.

                                                                                    v9.4.0

                                                                                    -
                                                                                    writableNeedDrain: boolean

                                                                                    Is true if the stream's buffer has been full and stream will emit 'drain'.

                                                                                    +
                                                                                    writableNeedDrain: boolean

                                                                                    Is true if the stream's buffer has been full and stream will emit 'drain'.

                                                                                    v15.2.0, v14.17.0

                                                                                    -
                                                                                    writableObjectMode: boolean

                                                                                    Getter for the property objectMode of a given Writable stream.

                                                                                    +
                                                                                    writableObjectMode: boolean

                                                                                    Getter for the property objectMode of a given Writable stream.

                                                                                    v12.3.0

                                                                                    -
                                                                                    captureRejections: boolean

                                                                                    Value: boolean

                                                                                    +
                                                                                    captureRejections: boolean

                                                                                    Value: boolean

                                                                                    Change the default captureRejections option on all new EventEmitter objects.

                                                                                    v13.4.0, v12.16.0

                                                                                    -
                                                                                    captureRejectionSymbol: typeof captureRejectionSymbol

                                                                                    Value: Symbol.for('nodejs.rejection')

                                                                                    +
                                                                                    captureRejectionSymbol: typeof captureRejectionSymbol

                                                                                    Value: Symbol.for('nodejs.rejection')

                                                                                    See how to write a custom rejection handler.

                                                                                    v13.4.0, v12.16.0

                                                                                    -
                                                                                    defaultMaxListeners: number

                                                                                    By default, a maximum of 10 listeners can be registered for any single +

                                                                                    defaultMaxListeners: number

                                                                                    By default, a maximum of 10 listeners can be registered for any single event. This limit can be changed for individual EventEmitter instances using the emitter.setMaxListeners(n) method. To change the default for allEventEmitter instances, the events.defaultMaxListeners property @@ -185,13 +185,16 @@ listeners, respectively. Its name property is set to 'MaxListenersExceededWarning'.

                                                                                    v0.11.2

                                                                                    -
                                                                                    errorMonitor: typeof errorMonitor

                                                                                    This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

                                                                                    +
                                                                                    errorMonitor: typeof errorMonitor

                                                                                    This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

                                                                                    Installing a listener using this symbol does not change the behavior once an 'error' event is emitted. Therefore, the process will still crash if no regular 'error' listener is installed.

                                                                                    v13.6.0, v12.17.0

                                                                                    -

                                                                                    Methods

                                                                                    Optional_construct

                                                                                    • _construct(callback: (error?: Error) => void): void

                                                                                      Parameters

                                                                                      • callback: (error?: Error) => void

                                                                                      Returns void

                                                                                    _destroy

                                                                                    • _destroy(error: Error, callback: (error?: Error) => void): void

                                                                                      Parameters

                                                                                      • error: Error
                                                                                      • callback: (error?: Error) => void

                                                                                      Returns void

                                                                                    _final

                                                                                    • _final(callback: (error?: Error) => void): void

                                                                                      Parameters

                                                                                      • callback: (error?: Error) => void

                                                                                      Returns void

                                                                                    _read

                                                                                    • _read(size: number): void

                                                                                      Parameters

                                                                                      • size: number

                                                                                      Returns void

                                                                                    _write

                                                                                    • _write(
                                                                                          chunk: any,
                                                                                          encoding: BufferEncoding,
                                                                                          callback: (error?: Error) => void,
                                                                                      ): void

                                                                                      Parameters

                                                                                      Returns void

                                                                                    Optional_writev

                                                                                    • _writev(
                                                                                          chunks: { chunk: any; encoding: BufferEncoding }[],
                                                                                          callback: (error?: Error) => void,
                                                                                      ): void

                                                                                      Parameters

                                                                                      • chunks: { chunk: any; encoding: BufferEncoding }[]
                                                                                      • callback: (error?: Error) => void

                                                                                      Returns void

                                                                                    • Calls readable.destroy() with an AbortError and returns a promise that fulfills when the stream is finished.

                                                                                      +

                                                                                    Methods

                                                                                    Optional_construct

                                                                                    • _construct?(callback: (error?: Error) => void): void

                                                                                      Parameters

                                                                                      • callback: (error?: Error) => void

                                                                                      Returns void

                                                                                    _destroy

                                                                                    • _destroy(error: Error, callback: (error?: Error) => void): void

                                                                                      Parameters

                                                                                      • error: Error
                                                                                      • callback: (error?: Error) => void

                                                                                      Returns void

                                                                                    _final

                                                                                    • _final(callback: (error?: Error) => void): void

                                                                                      Parameters

                                                                                      • callback: (error?: Error) => void

                                                                                      Returns void

                                                                                    _read

                                                                                    • _read(size: number): void

                                                                                      Parameters

                                                                                      • size: number

                                                                                      Returns void

                                                                                    _write

                                                                                    • _write(
                                                                                          chunk: any,
                                                                                          encoding: BufferEncoding,
                                                                                          callback: (error?: Error) => void,
                                                                                      ): void

                                                                                      Parameters

                                                                                      Returns void

                                                                                    Optional_writev

                                                                                    • _writev?(
                                                                                          chunks: { chunk: any; encoding: BufferEncoding }[],
                                                                                          callback: (error?: Error) => void,
                                                                                      ): void

                                                                                      Parameters

                                                                                      • chunks: { chunk: any; encoding: BufferEncoding }[]
                                                                                      • callback: (error?: Error) => void

                                                                                      Returns void

                                                                                    • Calls readable.destroy() with an AbortError and returns +a promise that fulfills when the stream is finished.

                                                                                      Returns Promise<void>

                                                                                      v20.4.0

                                                                                      -

                                                                                    • Event emitter +

                                                                                    • Event emitter The defined events on documents including:

                                                                                      1. close
                                                                                        2. @@ -206,7 +209,7 @@
                                                                                      2. resume
                                                                                      3. unpipe
                                                                                      -

                                                                                      Parameters

                                                                                      • event: "close"
                                                                                      • listener: () => void

                                                                                      Returns this

                                                                                    • Event emitter +

                                                                                      Parameters

                                                                                      • event: "close"
                                                                                      • listener: () => void

                                                                                      Returns this

                                                                                    • Event emitter The defined events on documents including:

                                                                                      1. close
                                                                                        2. @@ -221,7 +224,7 @@
                                                                                      2. resume
                                                                                      3. unpipe
                                                                                      -

                                                                                      Parameters

                                                                                      • event: "data"
                                                                                      • listener: (chunk: any) => void

                                                                                      Returns this

                                                                                    • Event emitter +

                                                                                      Parameters

                                                                                      • event: "data"
                                                                                      • listener: (chunk: any) => void

                                                                                      Returns this

                                                                                    • Event emitter The defined events on documents including:

                                                                                      1. close
                                                                                        2. @@ -236,7 +239,7 @@
                                                                                      2. resume
                                                                                      3. unpipe
                                                                                      -

                                                                                      Parameters

                                                                                      • event: "drain"
                                                                                      • listener: () => void

                                                                                      Returns this

                                                                                    • Event emitter +

                                                                                      Parameters

                                                                                      • event: "drain"
                                                                                      • listener: () => void

                                                                                      Returns this

                                                                                    • Event emitter The defined events on documents including:

                                                                                      1. close
                                                                                        2. @@ -251,7 +254,7 @@
                                                                                      2. resume
                                                                                      3. unpipe
                                                                                      -

                                                                                      Parameters

                                                                                      • event: "end"
                                                                                      • listener: () => void

                                                                                      Returns this

                                                                                    • Event emitter +

                                                                                      Parameters

                                                                                      • event: "end"
                                                                                      • listener: () => void

                                                                                      Returns this

                                                                                    • Event emitter The defined events on documents including:

                                                                                      1. close
                                                                                        2. @@ -266,7 +269,7 @@
                                                                                      2. resume
                                                                                      3. unpipe
                                                                                      -

                                                                                      Parameters

                                                                                      • event: "error"
                                                                                      • listener: (err: Error) => void

                                                                                      Returns this

                                                                                    • Event emitter +

                                                                                      Parameters

                                                                                      • event: "error"
                                                                                      • listener: (err: Error) => void

                                                                                      Returns this

                                                                                    • Event emitter The defined events on documents including:

                                                                                      1. close
                                                                                        2. @@ -281,7 +284,7 @@
                                                                                      2. resume
                                                                                      3. unpipe
                                                                                      -

                                                                                      Parameters

                                                                                      • event: "finish"
                                                                                      • listener: () => void

                                                                                      Returns this

                                                                                    • Event emitter +

                                                                                      Parameters

                                                                                      • event: "finish"
                                                                                      • listener: () => void

                                                                                      Returns this

                                                                                    • Event emitter The defined events on documents including:

                                                                                      1. close
                                                                                        2. @@ -296,7 +299,7 @@
                                                                                      2. resume
                                                                                      3. unpipe
                                                                                      -

                                                                                      Parameters

                                                                                      • event: "pause"
                                                                                      • listener: () => void

                                                                                      Returns this

                                                                                    • Event emitter +

                                                                                      Parameters

                                                                                      • event: "pause"
                                                                                      • listener: () => void

                                                                                      Returns this

                                                                                    • Event emitter The defined events on documents including:

                                                                                      1. close
                                                                                        2. @@ -311,7 +314,7 @@
                                                                                      2. resume
                                                                                      3. unpipe
                                                                                      -

                                                                                      Parameters

                                                                                      • event: "pipe"
                                                                                      • listener: (src: Readable) => void

                                                                                      Returns this

                                                                                    • Event emitter +

                                                                                      Parameters

                                                                                      • event: "pipe"
                                                                                      • listener: (src: Readable) => void

                                                                                      Returns this

                                                                                    • Event emitter The defined events on documents including:

                                                                                      1. close
                                                                                        2. @@ -326,7 +329,7 @@
                                                                                      2. resume
                                                                                      3. unpipe
                                                                                      -

                                                                                      Parameters

                                                                                      • event: "readable"
                                                                                      • listener: () => void

                                                                                      Returns this

                                                                                    • Event emitter +

                                                                                      Parameters

                                                                                      • event: "readable"
                                                                                      • listener: () => void

                                                                                      Returns this

                                                                                    • Event emitter The defined events on documents including:

                                                                                      1. close
                                                                                        2. @@ -341,7 +344,7 @@
                                                                                      2. resume
                                                                                      3. unpipe
                                                                                      -

                                                                                      Parameters

                                                                                      • event: "resume"
                                                                                      • listener: () => void

                                                                                      Returns this

                                                                                    • Event emitter +

                                                                                      Parameters

                                                                                      • event: "resume"
                                                                                      • listener: () => void

                                                                                      Returns this

                                                                                    • Event emitter The defined events on documents including:

                                                                                      1. close
                                                                                        2. @@ -356,7 +359,7 @@
                                                                                      2. resume
                                                                                      3. unpipe
                                                                                      -

                                                                                      Parameters

                                                                                      • event: "unpipe"
                                                                                      • listener: (src: Readable) => void

                                                                                      Returns this

                                                                                    • Event emitter +

                                                                                      Parameters

                                                                                      • event: "unpipe"
                                                                                      • listener: (src: Readable) => void

                                                                                      Returns this

                                                                                    • Event emitter The defined events on documents including:

                                                                                      1. close
                                                                                        2. @@ -371,11 +374,11 @@
                                                                                      2. resume
                                                                                      3. unpipe
                                                                                      -

                                                                                      Parameters

                                                                                      • event: string | symbol
                                                                                      • listener: (...args: any[]) => void

                                                                                      Returns this

                                                                                    • This method returns a new stream with chunks of the underlying stream paired with a counter +

                                                                                      Parameters

                                                                                      • event: string | symbol
                                                                                      • listener: (...args: any[]) => void

                                                                                      Returns this

                                                                                    • This method returns a new stream with chunks of the underlying stream paired with a counter in the form [index, chunk]. The first index value is 0 and it increases by 1 for each chunk produced.

                                                                                      Parameters

                                                                                      Returns Readable

                                                                                      a stream of indexed pairs.

                                                                                      -

                                                                                      v17.5.0

                                                                                      -

                                                                                    • The writable.cork() method forces all written data to be buffered in memory. +

                                                                                      v17.5.0

                                                                                      +

                                                                                    • The writable.cork() method forces all written data to be buffered in memory. The buffered data will be flushed when either the uncork or end methods are called.

                                                                                      The primary intent of writable.cork() is to accommodate a situation in which several small chunks are written to the stream in rapid succession. Instead of @@ -384,26 +387,26 @@ situation where data is being buffered while waiting for the first small chunk to be processed. However, use of writable.cork() without implementing writable._writev() may have an adverse effect on throughput.

                                                                                      See also: writable.uncork(), writable._writev().

                                                                                      -

                                                                                      Returns void

                                                                                      v0.11.2

                                                                                      -

                                                                                    • Destroy the stream. Optionally emit an 'error' event, and emit a 'close' event (unless emitClose is set to false). After this call, the readable +

                                                                                      Returns void

                                                                                      v0.11.2

                                                                                      +

                                                                                    • Destroy the stream. Optionally emit an 'error' event, and emit a 'close' event (unless emitClose is set to false). After this call, the readable stream will release any internal resources and subsequent calls to push() will be ignored.

                                                                                      Once destroy() has been called any further calls will be a no-op and no further errors except from _destroy() may be emitted as 'error'.

                                                                                      Implementors should not override this method, but instead implement readable._destroy().

                                                                                      Parameters

                                                                                      • Optionalerror: Error

                                                                                        Error which will be passed as payload in 'error' event

                                                                                        -

                                                                                      Returns this

                                                                                      v8.0.0

                                                                                      +

                                                                                    Returns this

                                                                                    v8.0.0

                                                                                    • This method returns a new stream with the first limit chunks dropped from the start.

                                                                                      Parameters

                                                                                      • limit: number

                                                                                        the number of chunks to drop from the readable.

                                                                                        -
                                                                                      • Optionaloptions: Pick<Stream.ArrayOptions, "signal">

                                                                                      Returns Readable

                                                                                      a stream with limit chunks dropped from the start.

                                                                                      -

                                                                                      v17.5.0

                                                                                      +
                                                                                    • Optionaloptions: Pick<Stream.ArrayOptions, "signal">

                                                                                    Returns Readable

                                                                                    a stream with limit chunks dropped from the start.

                                                                                    +

                                                                                    v17.5.0

                                                                                    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

                                                                                      Returns true if the event had listeners, false otherwise.

                                                                                      import { EventEmitter } from 'node:events';
                                                                                      const myEmitter = new EventEmitter();

                                                                                      // First listener
                                                                                      myEmitter.on('event', function firstListener() {
                                                                                        console.log('Helloooo! first listener');
                                                                                      });
                                                                                      // Second listener
                                                                                      myEmitter.on('event', function secondListener(arg1, arg2) {
                                                                                        console.log(`event with parameters ${arg1}, ${arg2} in second listener`);
                                                                                      });
                                                                                      // Third listener
                                                                                      myEmitter.on('event', function thirdListener(...args) {
                                                                                        const parameters = args.join(', ');
                                                                                        console.log(`event with parameters ${parameters} in third listener`);
                                                                                      });

                                                                                      console.log(myEmitter.listeners('event'));

                                                                                      myEmitter.emit('event', 1, 2, 3, 4, 5);

                                                                                      // Prints:
                                                                                      // [
                                                                                      //   [Function: firstListener],
                                                                                      //   [Function: secondListener],
                                                                                      //   [Function: thirdListener]
                                                                                      // ]
                                                                                      // Helloooo! first listener
                                                                                      // event with parameters 1, 2 in second listener
                                                                                      // event with parameters 1, 2, 3, 4, 5 in third listener
                                                                                      -

                                                                                      Parameters

                                                                                      • event: "close"

                                                                                      Returns boolean

                                                                                      v0.1.26

                                                                                      -

                                                                                    • Parameters

                                                                                      • event: "data"
                                                                                      • chunk: any

                                                                                      Returns boolean

                                                                                    • Parameters

                                                                                      • event: "drain"

                                                                                      Returns boolean

                                                                                    • Parameters

                                                                                      • event: "end"

                                                                                      Returns boolean

                                                                                    • Parameters

                                                                                      • event: "error"
                                                                                      • err: Error

                                                                                      Returns boolean

                                                                                    • Parameters

                                                                                      • event: "finish"

                                                                                      Returns boolean

                                                                                    • Parameters

                                                                                      • event: "pause"

                                                                                      Returns boolean

                                                                                    • Parameters

                                                                                      Returns boolean

                                                                                    • Parameters

                                                                                      • event: "readable"

                                                                                      Returns boolean

                                                                                    • Parameters

                                                                                      • event: "resume"

                                                                                      Returns boolean

                                                                                    • Parameters

                                                                                      Returns boolean

                                                                                    • Parameters

                                                                                      • event: string | symbol
                                                                                      • ...args: any[]

                                                                                      Returns boolean

                                                                                    • Calling the writable.end() method signals that no more data will be written +

                                                                                      Parameters

                                                                                      • event: "close"

                                                                                      Returns boolean

                                                                                      v0.1.26

                                                                                      +

                                                                                    • Parameters

                                                                                      • event: "data"
                                                                                      • chunk: any

                                                                                      Returns boolean

                                                                                    • Parameters

                                                                                      • event: "drain"

                                                                                      Returns boolean

                                                                                    • Parameters

                                                                                      • event: "end"

                                                                                      Returns boolean

                                                                                    • Parameters

                                                                                      • event: "error"
                                                                                      • err: Error

                                                                                      Returns boolean

                                                                                    • Parameters

                                                                                      • event: "finish"

                                                                                      Returns boolean

                                                                                    • Parameters

                                                                                      • event: "pause"

                                                                                      Returns boolean

                                                                                    • Parameters

                                                                                      Returns boolean

                                                                                    • Parameters

                                                                                      • event: "readable"

                                                                                      Returns boolean

                                                                                    • Parameters

                                                                                      • event: "resume"

                                                                                      Returns boolean

                                                                                    • Parameters

                                                                                      Returns boolean

                                                                                    • Parameters

                                                                                      • event: string | symbol
                                                                                      • ...args: any[]

                                                                                      Returns boolean

                                                                                    • Calling the writable.end() method signals that no more data will be written to the Writable. The optional chunk and encoding arguments allow one final additional chunk of data to be written immediately before closing the stream.

                                                                                      @@ -411,8 +414,8 @@ 
                                                                                      // Write 'hello, ' and then end with 'world!'.
                                                                                      import fs from 'node:fs';
                                                                                      const file = fs.createWriteStream('example.txt');
                                                                                      file.write('hello, ');
                                                                                      file.end('world!');
                                                                                      // Writing more now is not allowed!
                                                                                      -

                                                                                      Parameters

                                                                                      • Optionalcb: () => void

                                                                                      Returns this

                                                                                      v0.9.4

                                                                                      -

                                                                                    • Calling the writable.end() method signals that no more data will be written +

                                                                                      Parameters

                                                                                      • Optionalcb: () => void

                                                                                      Returns this

                                                                                      v0.9.4

                                                                                      +

                                                                                    • Calling the writable.end() method signals that no more data will be written to the Writable. The optional chunk and encoding arguments allow one final additional chunk of data to be written immediately before closing the stream.

                                                                                      @@ -422,8 +425,8 @@

                                                                                      Parameters

                                                                                      • chunk: any

                                                                                        Optional data to write. For streams not operating in object mode, chunk must be a {string}, {Buffer}, {TypedArray} or {DataView}. For object mode streams, chunk may be any JavaScript value other than null.

                                                                                        -
                                                                                      • Optionalcb: () => void

                                                                                      Returns this

                                                                                      v0.9.4

                                                                                      -

                                                                                    • Calling the writable.end() method signals that no more data will be written +

                                                                                    • Optionalcb: () => void

                                                                                    Returns this

                                                                                    v0.9.4

                                                                                    +

                                                                                  • Calling the writable.end() method signals that no more data will be written to the Writable. The optional chunk and encoding arguments allow one final additional chunk of data to be written immediately before closing the stream.

                                                                                    @@ -433,50 +436,50 @@

                                                                                    Parameters

                                                                                    • chunk: any

                                                                                      Optional data to write. For streams not operating in object mode, chunk must be a {string}, {Buffer}, {TypedArray} or {DataView}. For object mode streams, chunk may be any JavaScript value other than null.

                                                                                      -
                                                                                    • encoding: BufferEncoding

                                                                                      The encoding if chunk is a string

                                                                                      -
                                                                                    • Optionalcb: () => void

                                                                                    Returns this

                                                                                    v0.9.4

                                                                                    -

                                                                                    • Returns an array listing the events for which the emitter has registered +

                                                                                    • encoding: BufferEncoding

                                                                                      The encoding if chunk is a string

                                                                                      +
                                                                                    • Optionalcb: () => void

                                                                                    Returns this

                                                                                    v0.9.4

                                                                                    +

                                                                                    • Returns an array listing the events for which the emitter has registered listeners. The values in the array are strings or Symbols.

                                                                                      import { EventEmitter } from 'node:events';

                                                                                      const myEE = new EventEmitter();
                                                                                      myEE.on('foo', () => {});
                                                                                      myEE.on('bar', () => {});

                                                                                      const sym = Symbol('symbol');
                                                                                      myEE.on(sym, () => {});

                                                                                      console.log(myEE.eventNames());
                                                                                      // Prints: [ 'foo', 'bar', Symbol(symbol) ]
                                                                                      -

                                                                                      Returns (string | symbol)[]

                                                                                      v6.0.0

                                                                                      -

                                                                                    • This method is similar to Array.prototype.every and calls fn on each chunk in the stream +

                                                                                      Returns (string | symbol)[]

                                                                                      v6.0.0

                                                                                      +

                                                                                    • This method is similar to Array.prototype.every and calls fn on each chunk in the stream to check if all awaited return values are truthy value for fn. Once an fn call on a chunk awaited return value is falsy, the stream is destroyed and the promise is fulfilled with false. If all of the fn calls on the chunks return a truthy value, the promise is fulfilled with true.

                                                                                      Parameters

                                                                                      • fn: (
                                                                                            data: any,
                                                                                            options?: Pick<Stream.ArrayOptions, "signal">,
                                                                                        ) => boolean | Promise<boolean>

                                                                                        a function to call on each chunk of the stream. Async or not.

                                                                                        -
                                                                                      • Optionaloptions: Stream.ArrayOptions

                                                                                      Returns Promise<boolean>

                                                                                      a promise evaluating to true if fn returned a truthy value for every one of the chunks.

                                                                                      -

                                                                                      v17.5.0

                                                                                      +
                                                                                    • Optionaloptions: Stream.ArrayOptions

                                                                                    Returns Promise<boolean>

                                                                                    a promise evaluating to true if fn returned a truthy value for every one of the chunks.

                                                                                    +

                                                                                    v17.5.0

                                                                                    • This method allows filtering the stream. For each chunk in the stream the fn function will be called and if it returns a truthy value, the chunk will be passed to the result stream. If the fn function returns a promise - that promise will be awaited.

                                                                                      Parameters

                                                                                      • fn: (
                                                                                            data: any,
                                                                                            options?: Pick<Stream.ArrayOptions, "signal">,
                                                                                        ) => boolean | Promise<boolean>

                                                                                        a function to filter chunks from the stream. Async or not.

                                                                                        -
                                                                                      • Optionaloptions: Stream.ArrayOptions

                                                                                      Returns Readable

                                                                                      a stream filtered with the predicate fn.

                                                                                      -

                                                                                      v17.4.0, v16.14.0

                                                                                      +
                                                                                    • Optionaloptions: Stream.ArrayOptions

                                                                                    Returns Readable

                                                                                    a stream filtered with the predicate fn.

                                                                                    +

                                                                                    v17.4.0, v16.14.0

                                                                                    • This method is similar to Array.prototype.find and calls fn on each chunk in the stream to find a chunk with a truthy value for fn. Once an fn call's awaited return value is truthy, the stream is destroyed and the promise is fulfilled with value for which fn returned a truthy value. If all of the fn calls on the chunks return a falsy value, the promise is fulfilled with undefined.

                                                                                      Type Parameters

                                                                                      • T

                                                                                      Parameters

                                                                                      Returns Promise<T>

                                                                                      a promise evaluating to the first chunk for which fn evaluated with a truthy value, +

                                                                                    • Optionaloptions: Stream.ArrayOptions

                                                                                    Returns Promise<T>

                                                                                    a promise evaluating to the first chunk for which fn evaluated with a truthy value, or undefined if no element was found.

                                                                                    -

                                                                                    v17.5.0

                                                                                    +

                                                                                    v17.5.0

                                                                                  • This method is similar to Array.prototype.find and calls fn on each chunk in the stream to find a chunk with a truthy value for fn. Once an fn call's awaited return value is truthy, the stream is destroyed and the promise is fulfilled with value for which fn returned a truthy value. If all of the fn calls on the chunks return a falsy value, the promise is fulfilled with undefined.

                                                                                    Parameters

                                                                                    • fn: (
                                                                                          data: any,
                                                                                          options?: Pick<Stream.ArrayOptions, "signal">,
                                                                                      ) => boolean | Promise<boolean>

                                                                                      a function to call on each chunk of the stream. Async or not.

                                                                                      -
                                                                                    • Optionaloptions: Stream.ArrayOptions

                                                                                    Returns Promise<any>

                                                                                    a promise evaluating to the first chunk for which fn evaluated with a truthy value, +

                                                                                  • Optionaloptions: Stream.ArrayOptions

                                                                                    • Returns Promise<any>

                                                                                    a promise evaluating to the first chunk for which fn evaluated with a truthy value, or undefined if no element was found.

                                                                                    -

                                                                                    v17.5.0

                                                                                    +

                                                                                    v17.5.0

                                                                                    • This method returns a new stream by applying the given callback to each chunk of the stream and then flattening the result.

                                                                                      It is possible to return a stream or another iterable or async iterable from fn and the result streams will be merged (flattened) into the returned stream.

                                                                                      Parameters

                                                                                      • fn: (data: any, options?: Pick<Stream.ArrayOptions, "signal">) => any

                                                                                        a function to map over every chunk in the stream. May be async. May be a stream or generator.

                                                                                        -
                                                                                      • Optionaloptions: Stream.ArrayOptions

                                                                                      Returns Readable

                                                                                      a stream flat-mapped with the function fn.

                                                                                      -

                                                                                      v17.5.0

                                                                                      +
                                                                                    • Optionaloptions: Stream.ArrayOptions

                                                                                    Returns Readable

                                                                                    a stream flat-mapped with the function fn.

                                                                                    +

                                                                                    v17.5.0

                                                                                    • This method allows iterating a stream. For each chunk in the stream the fn function will be called. If the fn function returns a promise - that promise will be awaited.

                                                                                      This method is different from for await...of loops in that it can optionally process chunks concurrently. @@ -486,44 +489,44 @@

                                                                                      This method is different from listening to the 'data' event in that it uses the readable event in the underlying machinary and can limit the number of concurrent fn calls.

                                                                                      Parameters

                                                                                      • fn: (
                                                                                            data: any,
                                                                                            options?: Pick<Stream.ArrayOptions, "signal">,
                                                                                        ) => void | Promise<void>

                                                                                        a function to call on each chunk of the stream. Async or not.

                                                                                        -
                                                                                      • Optionaloptions: Stream.ArrayOptions

                                                                                      Returns Promise<void>

                                                                                      a promise for when the stream has finished.

                                                                                      -

                                                                                      v17.5.0

                                                                                      +
                                                                                    • Optionaloptions: Stream.ArrayOptions

                                                                                    Returns Promise<void>

                                                                                    a promise for when the stream has finished.

                                                                                    +

                                                                                    v17.5.0

                                                                                    • The readable.isPaused() method returns the current operating state of the Readable. +

                                                                                      Returns number

                                                                                      v1.0.0

                                                                                      +

                                                                                    • The readable.isPaused() method returns the current operating state of the Readable. This is used primarily by the mechanism that underlies the readable.pipe() method. In most typical cases, there will be no reason to use this method directly.

                                                                                      const readable = new stream.Readable();

                                                                                      readable.isPaused(); // === false
                                                                                      readable.pause();
                                                                                      readable.isPaused(); // === true
                                                                                      readable.resume();
                                                                                      readable.isPaused(); // === false
                                                                                      -

                                                                                      Returns boolean

                                                                                      v0.11.14

                                                                                      +

                                                                                      Returns boolean

                                                                                      v0.11.14

                                                                                    • The iterator created by this method gives users the option to cancel the destruction of the stream if the for await...of loop is exited by return, break, or throw, or if the iterator should destroy the stream if the stream emitted an error during iteration.

                                                                                      Parameters

                                                                                      • Optionaloptions: { destroyOnReturn?: boolean }
                                                                                        • OptionaldestroyOnReturn?: boolean

                                                                                          When set to false, calling return on the async iterator, or exiting a for await...of iteration using a break, return, or throw will not destroy the stream. Default: true.

                                                                                          -

                                                                                      Returns AsyncIterator<any>

                                                                                      v16.3.0

                                                                                      +

                                                                                    Returns AsyncIterator<any>

                                                                                    v16.3.0

                                                                                    • Returns the number of listeners listening for the event named eventName. If listener is provided, it will return how many times the listener is found in the list of the listeners of the event.

                                                                                      Type Parameters

                                                                                      • K

                                                                                      Parameters

                                                                                      • eventName: string | symbol

                                                                                        The name of the event being listened for

                                                                                        -
                                                                                      • Optionallistener: Function

                                                                                        The event handler function

                                                                                        -

                                                                                      Returns number

                                                                                      v3.2.0

                                                                                      -

                                                                                    • Returns a copy of the array of listeners for the event named eventName.

                                                                                      +
                                                                                    • Optionallistener: Function

                                                                                      The event handler function

                                                                                      +

                                                                                    Returns number

                                                                                    v3.2.0

                                                                                    +

                                                                                    • Returns a copy of the array of listeners for the event named eventName.

                                                                                      server.on('connection', (stream) => {
                                                                                        console.log('someone connected!');
                                                                                      });
                                                                                      console.log(util.inspect(server.listeners('connection')));
                                                                                      // Prints: [ [Function] ]
                                                                                      -

                                                                                      Type Parameters

                                                                                      • K

                                                                                      Parameters

                                                                                      • eventName: string | symbol

                                                                                      Returns Function[]

                                                                                      v0.1.26

                                                                                      -

                                                                                    • This method allows mapping over the stream. The fn function will be called for every chunk in the stream. +

                                                                                      Type Parameters

                                                                                      • K

                                                                                      Parameters

                                                                                      • eventName: string | symbol

                                                                                      Returns Function[]

                                                                                      v0.1.26

                                                                                      +

                                                                                    • This method allows mapping over the stream. The fn function will be called for every chunk in the stream. If the fn function returns a promise - that promise will be awaited before being passed to the result stream.

                                                                                      Parameters

                                                                                      Returns Readable

                                                                                      a stream mapped with the function fn.

                                                                                      -

                                                                                      v17.4.0, v16.14.0

                                                                                      +
                                                                                    • Optionaloptions: Stream.ArrayOptions

                                                                                    Returns Readable

                                                                                    a stream mapped with the function fn.

                                                                                    +

                                                                                    v17.4.0, v16.14.0

                                                                                    • Alias for emitter.removeListener().

                                                                                      -

                                                                                      Type Parameters

                                                                                      • K

                                                                                      Parameters

                                                                                      • eventName: string | symbol
                                                                                      • listener: (...args: any[]) => void

                                                                                      Returns this

                                                                                      v10.0.0

                                                                                      -

                                                                                    • Adds the listener function to the end of the listeners array for the event +

                                                                                      Type Parameters

                                                                                      • K

                                                                                      Parameters

                                                                                      • eventName: string | symbol
                                                                                      • listener: (...args: any[]) => void

                                                                                      Returns this

                                                                                      v10.0.0

                                                                                      +

                                                                                    • Adds the listener function to the end of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.

                                                                                      @@ -537,8 +540,8 @@

                                                                                      Parameters

                                                                                      • event: "close"
                                                                                      • listener: () => void

                                                                                        The callback function

                                                                                        -

                                                                                      Returns this

                                                                                      v0.1.101

                                                                                      -

                                                                                    • Parameters

                                                                                      • event: "data"
                                                                                      • listener: (chunk: any) => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "drain"
                                                                                      • listener: () => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "end"
                                                                                      • listener: () => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "error"
                                                                                      • listener: (err: Error) => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "finish"
                                                                                      • listener: () => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "pause"
                                                                                      • listener: () => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "pipe"
                                                                                      • listener: (src: Readable) => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "readable"
                                                                                      • listener: () => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "resume"
                                                                                      • listener: () => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "unpipe"
                                                                                      • listener: (src: Readable) => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: string | symbol
                                                                                      • listener: (...args: any[]) => void

                                                                                      Returns this

                                                                                    • Adds a one-time listener function for the event named eventName. The +

                                                                                    Returns this

                                                                                    v0.1.101

                                                                                    +

                                                                                  • Parameters

                                                                                    • event: "data"
                                                                                    • listener: (chunk: any) => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: "drain"
                                                                                    • listener: () => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: "end"
                                                                                    • listener: () => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: "error"
                                                                                    • listener: (err: Error) => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: "finish"
                                                                                    • listener: () => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: "pause"
                                                                                    • listener: () => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: "pipe"
                                                                                    • listener: (src: Readable) => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: "readable"
                                                                                    • listener: () => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: "resume"
                                                                                    • listener: () => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: "unpipe"
                                                                                    • listener: (src: Readable) => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: string | symbol
                                                                                    • listener: (...args: any[]) => void

                                                                                    Returns this

                                                                                    • Adds a one-time listener function for the event named eventName. The next time eventName is triggered, this listener is removed and then invoked.

                                                                                      server.once('connection', (stream) => {
                                                                                        console.log('Ah, we have our first user!');
                                                                                      });
                                                                                      @@ -550,16 +553,16 @@

                                                                                      Parameters

                                                                                      • event: "close"
                                                                                      • listener: () => void

                                                                                        The callback function

                                                                                        -

                                                                                      Returns this

                                                                                      v0.3.0

                                                                                      -

                                                                                    • Parameters

                                                                                      • event: "data"
                                                                                      • listener: (chunk: any) => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "drain"
                                                                                      • listener: () => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "end"
                                                                                      • listener: () => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "error"
                                                                                      • listener: (err: Error) => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "finish"
                                                                                      • listener: () => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "pause"
                                                                                      • listener: () => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "pipe"
                                                                                      • listener: (src: Readable) => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "readable"
                                                                                      • listener: () => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "resume"
                                                                                      • listener: () => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "unpipe"
                                                                                      • listener: (src: Readable) => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: string | symbol
                                                                                      • listener: (...args: any[]) => void

                                                                                      Returns this

                                                                                    • The readable.pause() method will cause a stream in flowing mode to stop +

                                                                                    Returns this

                                                                                    v0.3.0

                                                                                    +

                                                                                  • Parameters

                                                                                    • event: "data"
                                                                                    • listener: (chunk: any) => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: "drain"
                                                                                    • listener: () => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: "end"
                                                                                    • listener: () => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: "error"
                                                                                    • listener: (err: Error) => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: "finish"
                                                                                    • listener: () => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: "pause"
                                                                                    • listener: () => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: "pipe"
                                                                                    • listener: (src: Readable) => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: "readable"
                                                                                    • listener: () => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: "resume"
                                                                                    • listener: () => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: "unpipe"
                                                                                    • listener: (src: Readable) => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: string | symbol
                                                                                    • listener: (...args: any[]) => void

                                                                                    Returns this

                                                                                    • The readable.pause() method will cause a stream in flowing mode to stop emitting 'data' events, switching out of flowing mode. Any data that becomes available will remain in the internal buffer.

                                                                                      const readable = getReadableStreamSomehow();
                                                                                      readable.on('data', (chunk) => {
                                                                                        console.log(`Received ${chunk.length} bytes of data.`);
                                                                                        readable.pause();
                                                                                        console.log('There will be no additional data for 1 second.');
                                                                                        setTimeout(() => {
                                                                                          console.log('Now data will start flowing again.');
                                                                                          readable.resume();
                                                                                        }, 1000);
                                                                                      });

                                                                                      The readable.pause() method has no effect if there is a 'readable' event listener.

                                                                                      -

                                                                                      Returns this

                                                                                      v0.9.4

                                                                                      -

                                                                                    • Adds the listener function to the beginning of the listeners array for the +

                                                                                      Returns this

                                                                                      v0.9.4

                                                                                      +

                                                                                    • Adds the listener function to the beginning of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.

                                                                                      @@ -568,22 +571,22 @@

                                                                                      Returns a reference to the EventEmitter, so that calls can be chained.

                                                                                      Parameters

                                                                                      • event: "close"
                                                                                      • listener: () => void

                                                                                        The callback function

                                                                                        -

                                                                                      Returns this

                                                                                      v6.0.0

                                                                                      -

                                                                                    • Parameters

                                                                                      • event: "data"
                                                                                      • listener: (chunk: any) => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "drain"
                                                                                      • listener: () => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "end"
                                                                                      • listener: () => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "error"
                                                                                      • listener: (err: Error) => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "finish"
                                                                                      • listener: () => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "pause"
                                                                                      • listener: () => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "pipe"
                                                                                      • listener: (src: Readable) => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "readable"
                                                                                      • listener: () => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "resume"
                                                                                      • listener: () => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "unpipe"
                                                                                      • listener: (src: Readable) => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: string | symbol
                                                                                      • listener: (...args: any[]) => void

                                                                                      Returns this

                                                                                    • Adds a one-timelistener function for the event named eventName to the beginning of the listeners array. The next time eventName is triggered, this +

                                                                                    Returns this

                                                                                    v6.0.0

                                                                                    +

                                                                                  • Parameters

                                                                                    • event: "data"
                                                                                    • listener: (chunk: any) => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: "drain"
                                                                                    • listener: () => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: "end"
                                                                                    • listener: () => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: "error"
                                                                                    • listener: (err: Error) => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: "finish"
                                                                                    • listener: () => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: "pause"
                                                                                    • listener: () => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: "pipe"
                                                                                    • listener: (src: Readable) => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: "readable"
                                                                                    • listener: () => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: "resume"
                                                                                    • listener: () => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: "unpipe"
                                                                                    • listener: (src: Readable) => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: string | symbol
                                                                                    • listener: (...args: any[]) => void

                                                                                    Returns this

                                                                                    • Adds a one-timelistener function for the event named eventName to the beginning of the listeners array. The next time eventName is triggered, this listener is removed, and then invoked.

                                                                                      server.prependOnceListener('connection', (stream) => {
                                                                                        console.log('Ah, we have our first user!');
                                                                                      });

                                                                                      Returns a reference to the EventEmitter, so that calls can be chained.

                                                                                      Parameters

                                                                                      • event: "close"
                                                                                      • listener: () => void

                                                                                        The callback function

                                                                                        -

                                                                                      Returns this

                                                                                      v6.0.0

                                                                                      -

                                                                                    • Parameters

                                                                                      • event: "data"
                                                                                      • listener: (chunk: any) => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "drain"
                                                                                      • listener: () => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "end"
                                                                                      • listener: () => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "error"
                                                                                      • listener: (err: Error) => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "finish"
                                                                                      • listener: () => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "pause"
                                                                                      • listener: () => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "pipe"
                                                                                      • listener: (src: Readable) => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "readable"
                                                                                      • listener: () => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "resume"
                                                                                      • listener: () => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "unpipe"
                                                                                      • listener: (src: Readable) => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: string | symbol
                                                                                      • listener: (...args: any[]) => void

                                                                                      Returns this

                                                                                    • Returns a copy of the array of listeners for the event named eventName, +

                                                                                    Returns this

                                                                                    v6.0.0

                                                                                    +

                                                                                  • Parameters

                                                                                    • event: "data"
                                                                                    • listener: (chunk: any) => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: "drain"
                                                                                    • listener: () => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: "end"
                                                                                    • listener: () => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: "error"
                                                                                    • listener: (err: Error) => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: "finish"
                                                                                    • listener: () => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: "pause"
                                                                                    • listener: () => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: "pipe"
                                                                                    • listener: (src: Readable) => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: "readable"
                                                                                    • listener: () => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: "resume"
                                                                                    • listener: () => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: "unpipe"
                                                                                    • listener: (src: Readable) => void

                                                                                    Returns this

                                                                                  • Parameters

                                                                                    • event: string | symbol
                                                                                    • listener: (...args: any[]) => void

                                                                                    Returns this

                                                                                    • Returns a copy of the array of listeners for the event named eventName, including any wrappers (such as those created by .once()).

                                                                                      import { EventEmitter } from 'node:events';
                                                                                      const emitter = new EventEmitter();
                                                                                      emitter.once('log', () => console.log('log once'));

                                                                                      // Returns a new Array with a function `onceWrapper` which has a property
                                                                                      // `listener` which contains the original listener bound above
                                                                                      const listeners = emitter.rawListeners('log');
                                                                                      const logFnWrapper = listeners[0];

                                                                                      // Logs "log once" to the console and does not unbind the `once` event
                                                                                      logFnWrapper.listener();

                                                                                      // Logs "log once" to the console and removes the listener
                                                                                      logFnWrapper();

                                                                                      emitter.on('log', () => console.log('log persistently'));
                                                                                      // Will return a new Array with a single function bound by `.on()` above
                                                                                      const newListeners = emitter.rawListeners('log');

                                                                                      // Logs "log persistently" twice
                                                                                      newListeners[0]();
                                                                                      emitter.emit('log');
                                                                                      -

                                                                                      Type Parameters

                                                                                      • K

                                                                                      Parameters

                                                                                      • eventName: string | symbol

                                                                                      Returns Function[]

                                                                                      v9.4.0

                                                                                      -

                                                                                    • The readable.read() method reads data out of the internal buffer and +

                                                                                      Type Parameters

                                                                                      • K

                                                                                      Parameters

                                                                                      • eventName: string | symbol

                                                                                      Returns Function[]

                                                                                      v9.4.0

                                                                                      +

                                                                                    • The readable.read() method reads data out of the internal buffer and returns it. If no data is available to be read, null is returned. By default, the data is returned as a Buffer object unless an encoding has been specified using the readable.setEncoding() method or the stream is operating @@ -620,7 +623,7 @@

                                                                                      Calling read after the 'end' event has been emitted will return null. No runtime error will be raised.

                                                                                      Parameters

                                                                                      • Optionalsize: number

                                                                                        Optional argument to specify how much data to read.

                                                                                        -

                                                                                      Returns any

                                                                                      v0.9.4

                                                                                      +

                                                                                    Returns any

                                                                                    v0.9.4

                                                                                    • This method calls fn on each chunk of the stream in order, passing it the result from the calculation on the previous element. It returns a promise for the final value of the reduction.

                                                                                      If no initial value is supplied the first chunk of the stream is used as the initial value. @@ -628,9 +631,9 @@

                                                                                      The reducer function iterates the stream element-by-element which means that there is no concurrency parameter or parallelism. To perform a reduce concurrently, you can extract the async function to readable.map method.

                                                                                      Type Parameters

                                                                                      • T = any

                                                                                      Parameters

                                                                                      • fn: (previous: any, data: any, options?: Pick<Stream.ArrayOptions, "signal">) => T

                                                                                        a reducer function to call over every chunk in the stream. Async or not.

                                                                                        -
                                                                                      • Optionalinitial: undefined

                                                                                        the initial value to use in the reduction.

                                                                                        -
                                                                                      • Optionaloptions: Pick<Stream.ArrayOptions, "signal">

                                                                                      Returns Promise<T>

                                                                                      a promise for the final value of the reduction.

                                                                                      -

                                                                                      v17.5.0

                                                                                      +
                                                                                    • Optionalinitial: undefined

                                                                                      the initial value to use in the reduction.

                                                                                      +
                                                                                    • Optionaloptions: Pick<Stream.ArrayOptions, "signal">

                                                                                    Returns Promise<T>

                                                                                    a promise for the final value of the reduction.

                                                                                    +

                                                                                    v17.5.0

                                                                                  • This method calls fn on each chunk of the stream in order, passing it the result from the calculation on the previous element. It returns a promise for the final value of the reduction.

                                                                                    If no initial value is supplied the first chunk of the stream is used as the initial value. @@ -638,16 +641,16 @@

                                                                                    The reducer function iterates the stream element-by-element which means that there is no concurrency parameter or parallelism. To perform a reduce concurrently, you can extract the async function to readable.map method.

                                                                                    Type Parameters

                                                                                    • T = any

                                                                                    Parameters

                                                                                    • fn: (previous: T, data: any, options?: Pick<Stream.ArrayOptions, "signal">) => T

                                                                                      a reducer function to call over every chunk in the stream. Async or not.

                                                                                      -
                                                                                    • initial: T

                                                                                      the initial value to use in the reduction.

                                                                                      -
                                                                                    • Optionaloptions: Pick<Stream.ArrayOptions, "signal">

                                                                                    Returns Promise<T>

                                                                                    a promise for the final value of the reduction.

                                                                                    -

                                                                                    v17.5.0

                                                                                    +
                                                                                  • initial: T

                                                                                    the initial value to use in the reduction.

                                                                                    +
                                                                                  • Optionaloptions: Pick<Stream.ArrayOptions, "signal">

                                                                                    • Returns Promise<T>

                                                                                    a promise for the final value of the reduction.

                                                                                    +

                                                                                    v17.5.0

                                                                                    • Removes all listeners, or those of the specified eventName.

                                                                                      It is bad practice to remove listeners added elsewhere in the code, particularly when the EventEmitter instance was created by some other component or module (e.g. sockets or file streams).

                                                                                      Returns a reference to the EventEmitter, so that calls can be chained.

                                                                                      -

                                                                                      Parameters

                                                                                      • OptionaleventName: string | symbol

                                                                                      Returns this

                                                                                      v0.1.26

                                                                                      -

                                                                                    • Removes the specified listener from the listener array for the event named eventName.

                                                                                      +

                                                                                      Parameters

                                                                                      • OptionaleventName: string | symbol

                                                                                      Returns this

                                                                                      v0.1.26

                                                                                      +

                                                                                    • Removes the specified listener from the listener array for the event named eventName.

                                                                                      const callback = (stream) => {
                                                                                        console.log('someone connected!');
                                                                                      };
                                                                                      server.on('connection', callback);
                                                                                      // ...
                                                                                      server.removeListener('connection', callback);
                                                                                      @@ -673,8 +676,8 @@

                                                                                      Returns a reference to the EventEmitter, so that calls can be chained.

                                                                                      -

                                                                                      Parameters

                                                                                      • event: "close"
                                                                                      • listener: () => void

                                                                                      Returns this

                                                                                      v0.1.26

                                                                                      -

                                                                                    • Parameters

                                                                                      • event: "data"
                                                                                      • listener: (chunk: any) => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "drain"
                                                                                      • listener: () => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "end"
                                                                                      • listener: () => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "error"
                                                                                      • listener: (err: Error) => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "finish"
                                                                                      • listener: () => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "pause"
                                                                                      • listener: () => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "pipe"
                                                                                      • listener: (src: Readable) => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "readable"
                                                                                      • listener: () => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "resume"
                                                                                      • listener: () => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "unpipe"
                                                                                      • listener: (src: Readable) => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: string | symbol
                                                                                      • listener: (...args: any[]) => void

                                                                                      Returns this

                                                                                    • The readable.resume() method causes an explicitly paused Readable stream to +

                                                                                      Parameters

                                                                                      • event: "close"
                                                                                      • listener: () => void

                                                                                      Returns this

                                                                                      v0.1.26

                                                                                      +

                                                                                    • Parameters

                                                                                      • event: "data"
                                                                                      • listener: (chunk: any) => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "drain"
                                                                                      • listener: () => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "end"
                                                                                      • listener: () => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "error"
                                                                                      • listener: (err: Error) => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "finish"
                                                                                      • listener: () => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "pause"
                                                                                      • listener: () => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "pipe"
                                                                                      • listener: (src: Readable) => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "readable"
                                                                                      • listener: () => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "resume"
                                                                                      • listener: () => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "unpipe"
                                                                                      • listener: (src: Readable) => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: string | symbol
                                                                                      • listener: (...args: any[]) => void

                                                                                      Returns this

                                                                                    • The readable.resume() method causes an explicitly paused Readable stream to resume emitting 'data' events, switching the stream into flowing mode.

                                                                                      The readable.resume() method can be used to fully consume the data from a stream without actually processing any of that data:

                                                                                      @@ -682,11 +685,11 @@

                                                                                      The readable.resume() method has no effect if there is a 'readable' event listener.

                                                                                      -

                                                                                      Returns this

                                                                                      v0.9.4

                                                                                      +

                                                                                      Returns this

                                                                                      v0.9.4

                                                                                    • The writable.setDefaultEncoding() method sets the default encoding for a Writable stream.

                                                                                      Parameters

                                                                                      Returns this

                                                                                      v0.11.15

                                                                                      -

                                                                                    • The readable.setEncoding() method sets the character encoding for +

                                                                                    Returns this

                                                                                    v0.11.15

                                                                                    +

                                                                                    • The readable.setEncoding() method sets the character encoding for data read from the Readable stream.

                                                                                      By default, no encoding is assigned and stream data will be returned as Buffer objects. Setting an encoding causes the stream data to be returned as strings of the specified encoding rather than as Buffer objects. For instance, calling readable.setEncoding('utf8') will cause the @@ -699,29 +702,29 @@

                                                                                      Parameters

                                                                                      Returns this

                                                                                      v0.9.4

                                                                                      +

                                                                                    Returns this

                                                                                    v0.9.4

                                                                                    • By default EventEmitters will print a warning if more than 10 listeners are added for a particular event. This is a useful default that helps finding memory leaks. The emitter.setMaxListeners() method allows the limit to be modified for this specific EventEmitter instance. The value can be set to Infinity (or 0) to indicate an unlimited number of listeners.

                                                                                      Returns a reference to the EventEmitter, so that calls can be chained.

                                                                                      -

                                                                                      Parameters

                                                                                      • n: number

                                                                                      Returns this

                                                                                      v0.3.5

                                                                                      -

                                                                                    • This method is similar to Array.prototype.some and calls fn on each chunk in the stream +

                                                                                      Parameters

                                                                                      • n: number

                                                                                      Returns this

                                                                                      v0.3.5

                                                                                      +

                                                                                    • This method is similar to Array.prototype.some and calls fn on each chunk in the stream until the awaited return value is true (or any truthy value). Once an fn call on a chunk awaited return value is truthy, the stream is destroyed and the promise is fulfilled with true. If none of the fn calls on the chunks return a truthy value, the promise is fulfilled with false.

                                                                                      Parameters

                                                                                      • fn: (
                                                                                            data: any,
                                                                                            options?: Pick<Stream.ArrayOptions, "signal">,
                                                                                        ) => boolean | Promise<boolean>

                                                                                        a function to call on each chunk of the stream. Async or not.

                                                                                        -
                                                                                      • Optionaloptions: Stream.ArrayOptions

                                                                                      Returns Promise<boolean>

                                                                                      a promise evaluating to true if fn returned a truthy value for at least one of the chunks.

                                                                                      -

                                                                                      v17.5.0

                                                                                      +
                                                                                    • Optionaloptions: Stream.ArrayOptions

                                                                                    Returns Promise<boolean>

                                                                                    a promise evaluating to true if fn returned a truthy value for at least one of the chunks.

                                                                                    +

                                                                                    v17.5.0

                                                                                    Returns Readable

                                                                                    a stream with limit chunks taken.

                                                                                    +

                                                                                    v17.5.0

                                                                                    • This method allows easily obtaining the contents of a stream.

                                                                                      As this method reads the entire stream into memory, it negates the benefits of streams. It's intended for interoperability and convenience, not as the primary way to consume streams.

                                                                                      Parameters

                                                                                      Returns Promise<any[]>

                                                                                      a promise containing an array with the contents of the stream.

                                                                                      -

                                                                                      v17.5.0

                                                                                      +

                                                                                      v17.5.0

                                                                                    • The writable.uncork() method flushes all data buffered since cork was called.

                                                                                      When using writable.cork() and writable.uncork() to manage the buffering of writes to a stream, defer calls to writable.uncork() using process.nextTick(). Doing so allows batching of all writable.write() calls that occur within a given Node.js event @@ -736,8 +739,8 @@

                                                                                      See also: writable.cork().

                                                                                      -

                                                                                      Returns void

                                                                                      v0.11.2

                                                                                      -

                                                                                    • The readable.unpipe() method detaches a Writable stream previously attached +

                                                                                      Returns void

                                                                                      v0.11.2

                                                                                      +

                                                                                    • The readable.unpipe() method detaches a Writable stream previously attached using the pipe method.

                                                                                      If the destination is not specified, then all pipes are detached.

                                                                                      If the destination is specified, but no pipe is set up for it, then @@ -746,7 +749,7 @@

                                                                                      Parameters

                                                                                      • Optionaldestination: WritableStream

                                                                                        Optional specific stream to unpipe

                                                                                        -

                                                                                      Returns this

                                                                                      v0.9.4

                                                                                      +

                                                                                    Returns this

                                                                                    v0.9.4

                                                                                    • Passing chunk as null signals the end of the stream (EOF) and behaves the same as readable.push(null), after which no more data can be written. The EOF signal is put at the end of the buffer and any buffered data will still be @@ -771,8 +774,8 @@ process of performing a read.

                                                                                      Parameters

                                                                                      • chunk: any

                                                                                        Chunk of data to unshift onto the read queue. For streams not operating in object mode, chunk must be a {string}, {Buffer}, {TypedArray}, {DataView} or null. For object mode streams, chunk may be any JavaScript value.

                                                                                        -
                                                                                      • Optionalencoding: BufferEncoding

                                                                                        Encoding of string chunks. Must be a valid Buffer encoding, such as 'utf8' or 'ascii'.

                                                                                        -

                                                                                      Returns void

                                                                                      v0.9.11

                                                                                      +
                                                                                    • Optionalencoding: BufferEncoding

                                                                                      Encoding of string chunks. Must be a valid Buffer encoding, such as 'utf8' or 'ascii'.

                                                                                      +

                                                                                    Returns void

                                                                                    v0.9.11

                                                                                    • Prior to Node.js 0.10, streams did not implement the entire node:stream module API as it is currently defined. (See Compatibility for more information.)

                                                                                      When using an older Node.js library that emits 'data' events and has a pause method that is advisory only, the readable.wrap() method can be used to create a Readable @@ -785,7 +788,7 @@

                                                                                      Parameters

                                                                                      Returns this

                                                                                      v0.9.4

                                                                                      +

                                                                                    Returns this

                                                                                    v0.9.4

                                                                                    • The writable.write() method writes some data to the stream, and calls the supplied callback once the data has been fully handled. If an error occurs, the callback will be called with the error as its @@ -819,10 +822,10 @@

                                                                                      A Writable stream in object mode will always ignore the encoding argument.

                                                                                      Parameters

                                                                                      • chunk: any

                                                                                        Optional data to write. For streams not operating in object mode, chunk must be a {string}, {Buffer}, {TypedArray} or {DataView}. For object mode streams, chunk may be any JavaScript value other than null.

                                                                                        -
                                                                                      • Optionalcallback: (error: Error) => void

                                                                                        Callback for when this chunk of data is flushed.

                                                                                        -

                                                                                      Returns boolean

                                                                                      false if the stream wishes for the calling code to wait for the 'drain' event to be emitted before continuing to write additional data; otherwise true.

                                                                                      -

                                                                                      v0.9.4

                                                                                      -

                                                                                    • The writable.write() method writes some data to the stream, and calls the +

                                                                                    • Optionalcallback: (error: Error) => void

                                                                                      Callback for when this chunk of data is flushed.

                                                                                      +

                                                                                    Returns boolean

                                                                                    false if the stream wishes for the calling code to wait for the 'drain' event to be emitted before continuing to write additional data; otherwise true.

                                                                                    +

                                                                                    v0.9.4

                                                                                    +

                                                                                  • The writable.write() method writes some data to the stream, and calls the supplied callback once the data has been fully handled. If an error occurs, the callback will be called with the error as its first argument. The callback is called asynchronously and before 'error' is @@ -855,11 +858,11 @@

                                                                                    A Writable stream in object mode will always ignore the encoding argument.

                                                                                    Parameters

                                                                                    • chunk: any

                                                                                      Optional data to write. For streams not operating in object mode, chunk must be a {string}, {Buffer}, {TypedArray} or {DataView}. For object mode streams, chunk may be any JavaScript value other than null.

                                                                                      -
                                                                                    • encoding: BufferEncoding

                                                                                      The encoding, if chunk is a string.

                                                                                      -
                                                                                    • Optionalcallback: (error: Error) => void

                                                                                      Callback for when this chunk of data is flushed.

                                                                                      -

                                                                                    Returns boolean

                                                                                    false if the stream wishes for the calling code to wait for the 'drain' event to be emitted before continuing to write additional data; otherwise true.

                                                                                    -

                                                                                    v0.9.4

                                                                                    -

                                                                                    • Listens once to the abort event on the provided signal.

                                                                                      +
                                                                                    • encoding: BufferEncoding

                                                                                      The encoding, if chunk is a string.

                                                                                      +
                                                                                    • Optionalcallback: (error: Error) => void

                                                                                      Callback for when this chunk of data is flushed.

                                                                                      +

                                                                                    Returns boolean

                                                                                    false if the stream wishes for the calling code to wait for the 'drain' event to be emitted before continuing to write additional data; otherwise true.

                                                                                    +

                                                                                    v0.9.4

                                                                                    +

                                                                                    • Listens once to the abort event on the provided signal.

                                                                                      Listening to the abort event on abort signals is unsafe and may lead to resource leaks since another third party with the signal can call e.stopImmediatePropagation(). Unfortunately Node.js cannot change @@ -873,8 +876,8 @@

                                                                                      Parameters

                                                                                      Returns Disposable

                                                                                      Disposable that removes the abort listener.

                                                                                      -

                                                                                      v20.5.0

                                                                                      -

                                                                                    • A utility method for creating duplex streams.

                                                                                      +

                                                                                      v20.5.0

                                                                                      +

                                                                                    • A utility method for creating duplex streams.

                                                                                      • Stream converts writable stream into writable Duplex and readable stream to Duplex.
                                                                                        • @@ -892,10 +895,10 @@ Duplex will write to the writable and read from the readable.
                                                                                      • Promise converts into readable Duplex. Value null is ignored.
                                                                                      -

                                                                                      Parameters

                                                                                      Returns Duplex

                                                                                      v16.8.0

                                                                                      -

                                                                                    • A utility method for creating a Duplex from a web ReadableStream and WritableStream.

                                                                                      -

                                                                                      Parameters

                                                                                      • duplexStream: { readable: ReadableStream; writable: WritableStream }
                                                                                      • Optionaloptions: Pick<
                                                                                            DuplexOptions,
                                                                                            | "allowHalfOpen"
                                                                                            | "decodeStrings"
                                                                                            | "encoding"
                                                                                            | "highWaterMark"
                                                                                            | "objectMode"
                                                                                            | "signal",
                                                                                        >

                                                                                      Returns Duplex

                                                                                      v17.0.0

                                                                                      -

                                                                                    • Returns a copy of the array of listeners for the event named eventName.

                                                                                      +

                                                                                      Parameters

                                                                                      Returns Duplex

                                                                                      v16.8.0

                                                                                      +

                                                                                    • A utility method for creating a Duplex from a web ReadableStream and WritableStream.

                                                                                      +

                                                                                      Parameters

                                                                                      • duplexStream: { readable: ReadableStream; writable: WritableStream }
                                                                                      • Optionaloptions: Pick<
                                                                                            DuplexOptions,
                                                                                            | "allowHalfOpen"
                                                                                            | "decodeStrings"
                                                                                            | "encoding"
                                                                                            | "highWaterMark"
                                                                                            | "objectMode"
                                                                                            | "signal",
                                                                                        >

                                                                                      Returns Duplex

                                                                                      v17.0.0

                                                                                      +

                                                                                    • Returns a copy of the array of listeners for the event named eventName.

                                                                                      For EventEmitters this behaves exactly the same as calling .listeners on the emitter.

                                                                                      For EventTargets this is the only way to get the event listeners for the @@ -903,8 +906,8 @@ 

                                                                                      import { getEventListeners, EventEmitter } from 'node:events';

                                                                                      {
                                                                                        const ee = new EventEmitter();
                                                                                        const listener = () => console.log('Events are fun');
                                                                                        ee.on('foo', listener);
                                                                                        console.log(getEventListeners(ee, 'foo')); // [ [Function: listener] ]
                                                                                      }
                                                                                      {
                                                                                        const et = new EventTarget();
                                                                                        const listener = () => console.log('Events are fun');
                                                                                        et.addEventListener('foo', listener);
                                                                                        console.log(getEventListeners(et, 'foo')); // [ [Function: listener] ]
                                                                                      }
                                                                                      -

                                                                                      Parameters

                                                                                      Returns Function[]

                                                                                      v15.2.0, v14.17.0

                                                                                      -

                                                                                    • Returns the currently set max amount of listeners.

                                                                                      For EventEmitters this behaves exactly the same as calling .getMaxListeners on the emitter.

                                                                                      For EventTargets this is the only way to get the max event listeners for the @@ -913,16 +916,16 @@ 

                                                                                      import { getMaxListeners, setMaxListeners, EventEmitter } from 'node:events';

                                                                                      {
                                                                                        const ee = new EventEmitter();
                                                                                        console.log(getMaxListeners(ee)); // 10
                                                                                        setMaxListeners(11, ee);
                                                                                        console.log(getMaxListeners(ee)); // 11
                                                                                      }
                                                                                      {
                                                                                        const et = new EventTarget();
                                                                                        console.log(getMaxListeners(et)); // 10
                                                                                        setMaxListeners(11, et);
                                                                                        console.log(getMaxListeners(et)); // 11
                                                                                      }
                                                                                      -

                                                                                      Parameters

                                                                                      Returns number

                                                                                      v19.9.0

                                                                                      -

                                                                                    • A class method that returns the number of listeners for the given eventName registered on the given emitter.

                                                                                      +

                                                                                      Parameters

                                                                                      Returns number

                                                                                      v19.9.0

                                                                                      +

                                                                                    • A class method that returns the number of listeners for the given eventName registered on the given emitter.

                                                                                      import { EventEmitter, listenerCount } from 'node:events';

                                                                                      const myEmitter = new EventEmitter();
                                                                                      myEmitter.on('event', () => {});
                                                                                      myEmitter.on('event', () => {});
                                                                                      console.log(listenerCount(myEmitter, 'event'));
                                                                                      // Prints: 2

                                                                                      Parameters

                                                                                      • emitter: EventEmitter

                                                                                        The emitter to query

                                                                                        -
                                                                                      • eventName: string | symbol

                                                                                        The event name

                                                                                        -

                                                                                      Returns number

                                                                                      v0.9.12

                                                                                      +
                                                                                    • eventName: string | symbol

                                                                                      The event name

                                                                                      +

                                                                                    Returns number

                                                                                    v0.9.12

                                                                                    Since v3.2.0 - Use listenerCount instead.

                                                                                    -
                                                                                    • import { on, EventEmitter } from 'node:events';
                                                                                      import process from 'node:process';

                                                                                      const ee = new EventEmitter();

                                                                                      // Emit later on
                                                                                      process.nextTick(() => {
                                                                                        ee.emit('foo', 'bar');
                                                                                        ee.emit('foo', 42);
                                                                                      });

                                                                                      for await (const event of on(ee, 'foo')) {
                                                                                        // The execution of this inner block is synchronous and it
                                                                                        // processes one event at a time (even with await). Do not use
                                                                                        // if concurrent execution is required.
                                                                                        console.log(event); // prints ['bar'] [42]
                                                                                      }
                                                                                      // Unreachable here
+
                                                                                    • import { on, EventEmitter } from 'node:events';
                                                                                      import process from 'node:process';

                                                                                      const ee = new EventEmitter();

                                                                                      // Emit later on
                                                                                      process.nextTick(() => {
                                                                                        ee.emit('foo', 'bar');
                                                                                        ee.emit('foo', 42);
                                                                                      });

                                                                                      for await (const event of on(ee, 'foo')) {
                                                                                        // The execution of this inner block is synchronous and it
                                                                                        // processes one event at a time (even with await). Do not use
                                                                                        // if concurrent execution is required.
                                                                                        console.log(event); // prints ['bar'] [42]
                                                                                      }
                                                                                      // Unreachable here

                                                                                      Returns an AsyncIterator that iterates eventName events. It will throw @@ -938,8 +941,8 @@

                                                                                      Parameters

                                                                                      Returns AsyncIterator<any[]>

                                                                                      An AsyncIterator that iterates eventName events emitted by the emitter

                                                                                      -

                                                                                      v13.6.0, v12.16.0

                                                                                      -
                                                                                    • import { on, EventEmitter } from 'node:events';
                                                                                      import process from 'node:process';

                                                                                      const ee = new EventEmitter();

                                                                                      // Emit later on
                                                                                      process.nextTick(() => {
                                                                                        ee.emit('foo', 'bar');
                                                                                        ee.emit('foo', 42);
                                                                                      });

                                                                                      for await (const event of on(ee, 'foo')) {
                                                                                        // The execution of this inner block is synchronous and it
                                                                                        // processes one event at a time (even with await). Do not use
                                                                                        // if concurrent execution is required.
                                                                                        console.log(event); // prints ['bar'] [42]
                                                                                      }
                                                                                      // Unreachable here
+
                                                                                      v13.6.0, v12.16.0
                                                                                      
+
                                                                                    • import { on, EventEmitter } from 'node:events';
                                                                                      import process from 'node:process';

                                                                                      const ee = new EventEmitter();

                                                                                      // Emit later on
                                                                                      process.nextTick(() => {
                                                                                        ee.emit('foo', 'bar');
                                                                                        ee.emit('foo', 42);
                                                                                      });

                                                                                      for await (const event of on(ee, 'foo')) {
                                                                                        // The execution of this inner block is synchronous and it
                                                                                        // processes one event at a time (even with await). Do not use
                                                                                        // if concurrent execution is required.
                                                                                        console.log(event); // prints ['bar'] [42]
                                                                                      }
                                                                                      // Unreachable here

                                                                                      Returns an AsyncIterator that iterates eventName events. It will throw @@ -955,8 +958,8 @@

                                                                                      Parameters

                                                                                      Returns AsyncIterator<any[]>

                                                                                      An AsyncIterator that iterates eventName events emitted by the emitter

                                                                                      -

                                                                                      v13.6.0, v12.16.0

                                                                                      -

                                                                                    • Creates a Promise that is fulfilled when the EventEmitter emits the given +

                                                                                      v13.6.0, v12.16.0

                                                                                      +

                                                                                    • Creates a Promise that is fulfilled when the EventEmitter emits the given event or that is rejected if the EventEmitter emits 'error' while waiting. The Promise will resolve with an array of all the arguments emitted to the given event.

                                                                                      @@ -975,8 +978,8 @@ 
                                                                                      import { EventEmitter, once } from 'node:events';

                                                                                      const ee = new EventEmitter();
                                                                                      const ac = new AbortController();

                                                                                      async function foo(emitter, event, signal) {
                                                                                        try {
                                                                                          await once(emitter, event, { signal });
                                                                                          console.log('event emitted!');
                                                                                        } catch (error) {
                                                                                          if (error.name === 'AbortError') {
                                                                                            console.error('Waiting for the event was canceled!');
                                                                                          } else {
                                                                                            console.error('There was an error', error.message);
                                                                                          }
                                                                                        }
                                                                                      }

                                                                                      foo(ee, 'foo', ac.signal);
                                                                                      ac.abort(); // Abort waiting for the event
                                                                                      ee.emit('foo'); // Prints: Waiting for the event was canceled!
                                                                                      -

                                                                                      Parameters

                                                                                      Returns Promise<any[]>

                                                                                      v11.13.0, v10.16.0

                                                                                      -

                                                                                    • Creates a Promise that is fulfilled when the EventEmitter emits the given +

                                                                                      Parameters

                                                                                      Returns Promise<any[]>

                                                                                      v11.13.0, v10.16.0

                                                                                      +

                                                                                    • Creates a Promise that is fulfilled when the EventEmitter emits the given event or that is rejected if the EventEmitter emits 'error' while waiting. The Promise will resolve with an array of all the arguments emitted to the given event.

                                                                                      @@ -995,14 +998,14 @@ 
                                                                                      import { EventEmitter, once } from 'node:events';

                                                                                      const ee = new EventEmitter();
                                                                                      const ac = new AbortController();

                                                                                      async function foo(emitter, event, signal) {
                                                                                        try {
                                                                                          await once(emitter, event, { signal });
                                                                                          console.log('event emitted!');
                                                                                        } catch (error) {
                                                                                          if (error.name === 'AbortError') {
                                                                                            console.error('Waiting for the event was canceled!');
                                                                                          } else {
                                                                                            console.error('There was an error', error.message);
                                                                                          }
                                                                                        }
                                                                                      }

                                                                                      foo(ee, 'foo', ac.signal);
                                                                                      ac.abort(); // Abort waiting for the event
                                                                                      ee.emit('foo'); // Prints: Waiting for the event was canceled!
                                                                                      -

                                                                                      Parameters

                                                                                      Returns Promise<any[]>

                                                                                      v11.13.0, v10.16.0

                                                                                      -
                                                                                    • import { setMaxListeners, EventEmitter } from 'node:events';

                                                                                      const target = new EventTarget();
                                                                                      const emitter = new EventEmitter();

                                                                                      setMaxListeners(5, target, emitter);
+

                                                                                      Parameters

                                                                                      Returns Promise<any[]>

                                                                                      v11.13.0, v10.16.0

                                                                                      +
                                                                                    • import { setMaxListeners, EventEmitter } from 'node:events';

                                                                                      const target = new EventTarget();
                                                                                      const emitter = new EventEmitter();

                                                                                      setMaxListeners(5, target, emitter);

                                                                                      Parameters

                                                                                      • Optionaln: number

                                                                                        A non-negative number. The maximum number of listeners per EventTarget event.

                                                                                        -
                                                                                      • ...eventTargets: (EventEmitter<DefaultEventMap> | EventTarget)[]

                                                                                        Zero or more {EventTarget} or {EventEmitter} instances. If none are specified, n is set as the default max for all newly created {EventTarget} and {EventEmitter} +

                                                                                      • ...eventTargets: (EventEmitter<DefaultEventMap> | EventTarget)[]

                                                                                        Zero or more {EventTarget} or {EventEmitter} instances. If none are specified, n is set as the default max for all newly created {EventTarget} and {EventEmitter} objects.

                                                                                        -

                                                                                      Returns void

                                                                                      v15.4.0

                                                                                      -

                                                                                    Settings

                                                                                    Member Visibility

                                                                                    On This Page

                                                                                    Constructors
                                                                                    Properties
                                                                                    Methods
                                                                                    +

                                                                                    Returns void

                                                                                    v15.4.0

                                                                                    +

                                                                                    Settings

                                                                                    Member Visibility

                                                                                    On This Page

                                                                                    Constructors
                                                                                    Properties
                                                                                    Methods
                                                                                    diff --git a/docs/classes/_internal_.Stream.PassThrough.html b/docs/classes/_internal_.Stream.PassThrough.html index e0108b46..6bc8d2ec 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.2
                                                                                    ts-lambda-api - v2.5.2
                                                                                      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 @@ -93,13 +93,13 @@ once setMaxListeners toWeb -

                                                                                      Constructors

                                                                                      Properties

                                                                                      allowHalfOpen: boolean

                                                                                      If false then the stream will automatically end the writable side when the +

                                                                                      Constructors

                                                                                      Properties

                                                                                      allowHalfOpen: boolean

                                                                                      If false then the stream will automatically end the writable side when the readable side ends. Set initially by the allowHalfOpen constructor option, which defaults to true.

                                                                                      This can be changed manually to change the half-open behavior of an existing Duplex stream instance, but must be changed before the 'end' event is emitted.

                                                                                      v0.9.4

                                                                                      -
                                                                                      closed: boolean

                                                                                      Is true after 'close' has been emitted.

                                                                                      +
                                                                                      closed: boolean

                                                                                      Is true after 'close' has been emitted.

                                                                                      v18.0.0

                                                                                      destroyed: boolean

                                                                                      Is true after readable.destroy() has been called.

                                                                                      v8.0.0

                                                                                      @@ -130,33 +130,33 @@
                                                                                      writable: boolean

                                                                                      Is true if it is safe to call writable.write(), which means the stream has not been destroyed, errored, or ended.

                                                                                      v11.4.0

                                                                                      -
                                                                                      writableAborted: boolean

                                                                                      Returns whether the stream was destroyed or errored before emitting 'finish'.

                                                                                      +
                                                                                      writableAborted: boolean

                                                                                      Returns whether the stream was destroyed or errored before emitting 'finish'.

                                                                                      v18.0.0, v16.17.0

                                                                                      -
                                                                                      writableCorked: number

                                                                                      Number of times writable.uncork() needs to be +

                                                                                      writableCorked: number

                                                                                      Number of times writable.uncork() needs to be called in order to fully uncork the stream.

                                                                                      v13.2.0, v12.16.0

                                                                                      -
                                                                                      writableEnded: boolean

                                                                                      Is true after writable.end() has been called. This property +

                                                                                      writableEnded: boolean

                                                                                      Is true after writable.end() has been called. This property does not indicate whether the data has been flushed, for this use writable.writableFinished instead.

                                                                                      v12.9.0

                                                                                      -
                                                                                      writableFinished: boolean

                                                                                      Is set to true immediately before the 'finish' event is emitted.

                                                                                      +
                                                                                      writableFinished: boolean

                                                                                      Is set to true immediately before the 'finish' event is emitted.

                                                                                      v12.6.0

                                                                                      -
                                                                                      writableHighWaterMark: number

                                                                                      Return the value of highWaterMark passed when creating this Writable.

                                                                                      +
                                                                                      writableHighWaterMark: number

                                                                                      Return the value of highWaterMark passed when creating this Writable.

                                                                                      v9.3.0

                                                                                      -
                                                                                      writableLength: number

                                                                                      This property contains the number of bytes (or objects) in the queue +

                                                                                      writableLength: number

                                                                                      This property contains the number of bytes (or objects) in the queue ready to be written. The value provides introspection data regarding the status of the highWaterMark.

                                                                                      v9.4.0

                                                                                      -
                                                                                      writableNeedDrain: boolean

                                                                                      Is true if the stream's buffer has been full and stream will emit 'drain'.

                                                                                      +
                                                                                      writableNeedDrain: boolean

                                                                                      Is true if the stream's buffer has been full and stream will emit 'drain'.

                                                                                      v15.2.0, v14.17.0

                                                                                      -
                                                                                      writableObjectMode: boolean

                                                                                      Getter for the property objectMode of a given Writable stream.

                                                                                      +
                                                                                      writableObjectMode: boolean

                                                                                      Getter for the property objectMode of a given Writable stream.

                                                                                      v12.3.0

                                                                                      -
                                                                                      captureRejections: boolean

                                                                                      Value: boolean

                                                                                      +
                                                                                      captureRejections: boolean

                                                                                      Value: boolean

                                                                                      Change the default captureRejections option on all new EventEmitter objects.

                                                                                      v13.4.0, v12.16.0

                                                                                      -
                                                                                      captureRejectionSymbol: typeof captureRejectionSymbol

                                                                                      Value: Symbol.for('nodejs.rejection')

                                                                                      +
                                                                                      captureRejectionSymbol: typeof captureRejectionSymbol

                                                                                      Value: Symbol.for('nodejs.rejection')

                                                                                      See how to write a custom rejection handler.

                                                                                      v13.4.0, v12.16.0

                                                                                      -
                                                                                      defaultMaxListeners: number

                                                                                      By default, a maximum of 10 listeners can be registered for any single +

                                                                                      defaultMaxListeners: number

                                                                                      By default, a maximum of 10 listeners can be registered for any single event. This limit can be changed for individual EventEmitter instances using the emitter.setMaxListeners(n) method. To change the default for allEventEmitter instances, the events.defaultMaxListeners property @@ -181,13 +181,16 @@ listeners, respectively. Its name property is set to 'MaxListenersExceededWarning'.

                                                                                      v0.11.2

                                                                                      -
                                                                                      errorMonitor: typeof errorMonitor

                                                                                      This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

                                                                                      +
                                                                                      errorMonitor: typeof errorMonitor

                                                                                      This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

                                                                                      Installing a listener using this symbol does not change the behavior once an 'error' event is emitted. Therefore, the process will still crash if no regular 'error' listener is installed.

                                                                                      v13.6.0, v12.17.0

                                                                                      -

                                                                                      Methods

                                                                                      Optional_construct

                                                                                      • _construct(callback: (error?: Error) => void): void

                                                                                        Parameters

                                                                                        • callback: (error?: Error) => void

                                                                                        Returns void

                                                                                      _destroy

                                                                                      • _destroy(error: Error, callback: (error?: Error) => void): void

                                                                                        Parameters

                                                                                        • error: Error
                                                                                        • callback: (error?: Error) => void

                                                                                        Returns void

                                                                                      _final

                                                                                      • _final(callback: (error?: Error) => void): void

                                                                                        Parameters

                                                                                        • callback: (error?: Error) => void

                                                                                        Returns void

                                                                                      _flush

                                                                                      _read

                                                                                      • _read(size: number): void

                                                                                        Parameters

                                                                                        • size: number

                                                                                        Returns void

                                                                                      _transform

                                                                                      _write

                                                                                      • _write(
                                                                                            chunk: any,
                                                                                            encoding: BufferEncoding,
                                                                                            callback: (error?: Error) => void,
                                                                                        ): void

                                                                                        Parameters

                                                                                        Returns void

                                                                                      Optional_writev

                                                                                      • _writev(
                                                                                            chunks: { chunk: any; encoding: BufferEncoding }[],
                                                                                            callback: (error?: Error) => void,
                                                                                        ): void

                                                                                        Parameters

                                                                                        • chunks: { chunk: any; encoding: BufferEncoding }[]
                                                                                        • callback: (error?: Error) => void

                                                                                        Returns void

                                                                                      • Calls readable.destroy() with an AbortError and returns a promise that fulfills when the stream is finished.

                                                                                        +

                                                                                      Methods

                                                                                      Optional_construct

                                                                                      • _construct?(callback: (error?: Error) => void): void

                                                                                        Parameters

                                                                                        • callback: (error?: Error) => void

                                                                                        Returns void

                                                                                      _destroy

                                                                                      • _destroy(error: Error, callback: (error?: Error) => void): void

                                                                                        Parameters

                                                                                        • error: Error
                                                                                        • callback: (error?: Error) => void

                                                                                        Returns void

                                                                                      _final

                                                                                      • _final(callback: (error?: Error) => void): void

                                                                                        Parameters

                                                                                        • callback: (error?: Error) => void

                                                                                        Returns void

                                                                                      _flush

                                                                                      _read

                                                                                      • _read(size: number): void

                                                                                        Parameters

                                                                                        • size: number

                                                                                        Returns void

                                                                                      _transform

                                                                                      _write

                                                                                      • _write(
                                                                                            chunk: any,
                                                                                            encoding: BufferEncoding,
                                                                                            callback: (error?: Error) => void,
                                                                                        ): void

                                                                                        Parameters

                                                                                        Returns void

                                                                                      Optional_writev

                                                                                      • _writev?(
                                                                                            chunks: { chunk: any; encoding: BufferEncoding }[],
                                                                                            callback: (error?: Error) => void,
                                                                                        ): void

                                                                                        Parameters

                                                                                        • chunks: { chunk: any; encoding: BufferEncoding }[]
                                                                                        • callback: (error?: Error) => void

                                                                                        Returns void

                                                                                      • Calls readable.destroy() with an AbortError and returns +a promise that fulfills when the stream is finished.

                                                                                        Returns Promise<void>

                                                                                        v20.4.0

                                                                                        -

                                                                                      • Returns AsyncIterator<any>

                                                                                      • Type Parameters

                                                                                        • K

                                                                                        Parameters

                                                                                        • error: Error
                                                                                        • event: string | symbol
                                                                                        • ...args: AnyRest

                                                                                        Returns void

                                                                                      • Event emitter +

                                                                                      • Returns AsyncIterator<any>

                                                                                        AsyncIterator to fully consume the stream.

                                                                                        +

                                                                                        v10.0.0

                                                                                        +

                                                                                      • Type Parameters

                                                                                        • K

                                                                                        Parameters

                                                                                        • error: Error
                                                                                        • event: string | symbol
                                                                                        • ...args: AnyRest

                                                                                        Returns void

                                                                                      • Event emitter The defined events on documents including:

                                                                                        1. close
                                                                                          2. @@ -202,7 +205,7 @@
                                                                                        2. resume
                                                                                        3. unpipe
                                                                                        -

                                                                                        Parameters

                                                                                        • event: "close"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Event emitter +

                                                                                        Parameters

                                                                                        • event: "close"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Event emitter The defined events on documents including:

                                                                                        1. close
                                                                                          2. @@ -217,7 +220,7 @@
                                                                                        2. resume
                                                                                        3. unpipe
                                                                                        -

                                                                                        Parameters

                                                                                        • event: "data"
                                                                                        • listener: (chunk: any) => void

                                                                                        Returns this

                                                                                      • Event emitter +

                                                                                        Parameters

                                                                                        • event: "data"
                                                                                        • listener: (chunk: any) => void

                                                                                        Returns this

                                                                                      • Event emitter The defined events on documents including:

                                                                                        1. close
                                                                                          2. @@ -232,7 +235,7 @@
                                                                                        2. resume
                                                                                        3. unpipe
                                                                                        -

                                                                                        Parameters

                                                                                        • event: "drain"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Event emitter +

                                                                                        Parameters

                                                                                        • event: "drain"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Event emitter The defined events on documents including:

                                                                                        1. close
                                                                                          2. @@ -247,7 +250,7 @@
                                                                                        2. resume
                                                                                        3. unpipe
                                                                                        -

                                                                                        Parameters

                                                                                        • event: "end"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Event emitter +

                                                                                        Parameters

                                                                                        • event: "end"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Event emitter The defined events on documents including:

                                                                                        1. close
                                                                                          2. @@ -262,7 +265,7 @@
                                                                                        2. resume
                                                                                        3. unpipe
                                                                                        -

                                                                                        Parameters

                                                                                        • event: "error"
                                                                                        • listener: (err: Error) => void

                                                                                        Returns this

                                                                                      • Event emitter +

                                                                                        Parameters

                                                                                        • event: "error"
                                                                                        • listener: (err: Error) => void

                                                                                        Returns this

                                                                                      • Event emitter The defined events on documents including:

                                                                                        1. close
                                                                                          2. @@ -277,7 +280,7 @@
                                                                                        2. resume
                                                                                        3. unpipe
                                                                                        -

                                                                                        Parameters

                                                                                        • event: "finish"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Event emitter +

                                                                                        Parameters

                                                                                        • event: "finish"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Event emitter The defined events on documents including:

                                                                                        1. close
                                                                                          2. @@ -292,7 +295,7 @@
                                                                                        2. resume
                                                                                        3. unpipe
                                                                                        -

                                                                                        Parameters

                                                                                        • event: "pause"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Event emitter +

                                                                                        Parameters

                                                                                        • event: "pause"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Event emitter The defined events on documents including:

                                                                                        1. close
                                                                                          2. @@ -307,7 +310,7 @@
                                                                                        2. resume
                                                                                        3. unpipe
                                                                                        -

                                                                                        Parameters

                                                                                        • event: "pipe"
                                                                                        • listener: (src: Readable) => void

                                                                                        Returns this

                                                                                      • Event emitter +

                                                                                        Parameters

                                                                                        • event: "pipe"
                                                                                        • listener: (src: Readable) => void

                                                                                        Returns this

                                                                                      • Event emitter The defined events on documents including:

                                                                                        1. close
                                                                                          2. @@ -322,7 +325,7 @@
                                                                                        2. resume
                                                                                        3. unpipe
                                                                                        -

                                                                                        Parameters

                                                                                        • event: "readable"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Event emitter +

                                                                                        Parameters

                                                                                        • event: "readable"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Event emitter The defined events on documents including:

                                                                                        1. close
                                                                                          2. @@ -337,7 +340,7 @@
                                                                                        2. resume
                                                                                        3. unpipe
                                                                                        -

                                                                                        Parameters

                                                                                        • event: "resume"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Event emitter +

                                                                                        Parameters

                                                                                        • event: "resume"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Event emitter The defined events on documents including:

                                                                                        1. close
                                                                                          2. @@ -352,7 +355,7 @@
                                                                                        2. resume
                                                                                        3. unpipe
                                                                                        -

                                                                                        Parameters

                                                                                        • event: "unpipe"
                                                                                        • listener: (src: Readable) => void

                                                                                        Returns this

                                                                                      • Event emitter +

                                                                                        Parameters

                                                                                        • event: "unpipe"
                                                                                        • listener: (src: Readable) => void

                                                                                        Returns this

                                                                                      • Event emitter The defined events on documents including:

                                                                                        1. close
                                                                                          2. @@ -367,11 +370,11 @@
                                                                                        2. resume
                                                                                        3. unpipe
                                                                                        -

                                                                                        Parameters

                                                                                        • event: string | symbol
                                                                                        • listener: (...args: any[]) => void

                                                                                        Returns this

                                                                                      • This method returns a new stream with chunks of the underlying stream paired with a counter +

                                                                                        Parameters

                                                                                        • event: string | symbol
                                                                                        • listener: (...args: any[]) => void

                                                                                        Returns this

                                                                                      • This method returns a new stream with chunks of the underlying stream paired with a counter in the form [index, chunk]. The first index value is 0 and it increases by 1 for each chunk produced.

                                                                                        Parameters

                                                                                        Returns Readable

                                                                                        a stream of indexed pairs.

                                                                                        -

                                                                                        v17.5.0

                                                                                        -

                                                                                      • The writable.cork() method forces all written data to be buffered in memory. +

                                                                                        v17.5.0

                                                                                        +

                                                                                      • The writable.cork() method forces all written data to be buffered in memory. The buffered data will be flushed when either the uncork or end methods are called.

                                                                                        The primary intent of writable.cork() is to accommodate a situation in which several small chunks are written to the stream in rapid succession. Instead of @@ -380,26 +383,26 @@ situation where data is being buffered while waiting for the first small chunk to be processed. However, use of writable.cork() without implementing writable._writev() may have an adverse effect on throughput.

                                                                                        See also: writable.uncork(), writable._writev().

                                                                                        -

                                                                                        Returns void

                                                                                        v0.11.2

                                                                                        -

                                                                                      • Destroy the stream. Optionally emit an 'error' event, and emit a 'close' event (unless emitClose is set to false). After this call, the readable +

                                                                                        Returns void

                                                                                        v0.11.2

                                                                                        +

                                                                                      • Destroy the stream. Optionally emit an 'error' event, and emit a 'close' event (unless emitClose is set to false). After this call, the readable stream will release any internal resources and subsequent calls to push() will be ignored.

                                                                                        Once destroy() has been called any further calls will be a no-op and no further errors except from _destroy() may be emitted as 'error'.

                                                                                        Implementors should not override this method, but instead implement readable._destroy().

                                                                                        Parameters

                                                                                        • Optionalerror: Error

                                                                                          Error which will be passed as payload in 'error' event

                                                                                          -

                                                                                        Returns this

                                                                                        v8.0.0

                                                                                        -

                                                                                      • This method returns a new stream with the first limit chunks dropped from the start.

                                                                                        +

                                                                                      Returns this

                                                                                      v8.0.0

                                                                                      +

                                                                                      • This method returns a new stream with the first limit chunks dropped from the start.

                                                                                        Parameters

                                                                                        • limit: number

                                                                                          the number of chunks to drop from the readable.

                                                                                          -
                                                                                        • Optionaloptions: Pick<Stream.ArrayOptions, "signal">

                                                                                        Returns Readable

                                                                                        a stream with limit chunks dropped from the start.

                                                                                        -

                                                                                        v17.5.0

                                                                                        +
                                                                                      • Optionaloptions: Pick<Stream.ArrayOptions, "signal">

                                                                                      Returns Readable

                                                                                      a stream with limit chunks dropped from the start.

                                                                                      +

                                                                                      v17.5.0

                                                                                      • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

                                                                                        Returns true if the event had listeners, false otherwise.

                                                                                        import { EventEmitter } from 'node:events';
                                                                                        const myEmitter = new EventEmitter();

                                                                                        // First listener
                                                                                        myEmitter.on('event', function firstListener() {
                                                                                          console.log('Helloooo! first listener');
                                                                                        });
                                                                                        // Second listener
                                                                                        myEmitter.on('event', function secondListener(arg1, arg2) {
                                                                                          console.log(`event with parameters ${arg1}, ${arg2} in second listener`);
                                                                                        });
                                                                                        // Third listener
                                                                                        myEmitter.on('event', function thirdListener(...args) {
                                                                                          const parameters = args.join(', ');
                                                                                          console.log(`event with parameters ${parameters} in third listener`);
                                                                                        });

                                                                                        console.log(myEmitter.listeners('event'));

                                                                                        myEmitter.emit('event', 1, 2, 3, 4, 5);

                                                                                        // Prints:
                                                                                        // [
                                                                                        //   [Function: firstListener],
                                                                                        //   [Function: secondListener],
                                                                                        //   [Function: thirdListener]
                                                                                        // ]
                                                                                        // Helloooo! first listener
                                                                                        // event with parameters 1, 2 in second listener
                                                                                        // event with parameters 1, 2, 3, 4, 5 in third listener
                                                                                        -

                                                                                        Parameters

                                                                                        • event: "close"

                                                                                        Returns boolean

                                                                                        v0.1.26

                                                                                        -

                                                                                      • Parameters

                                                                                        • event: "data"
                                                                                        • chunk: any

                                                                                        Returns boolean

                                                                                      • Parameters

                                                                                        • event: "drain"

                                                                                        Returns boolean

                                                                                      • Parameters

                                                                                        • event: "end"

                                                                                        Returns boolean

                                                                                      • Parameters

                                                                                        • event: "error"
                                                                                        • err: Error

                                                                                        Returns boolean

                                                                                      • Parameters

                                                                                        • event: "finish"

                                                                                        Returns boolean

                                                                                      • Parameters

                                                                                        • event: "pause"

                                                                                        Returns boolean

                                                                                      • Parameters

                                                                                        Returns boolean

                                                                                      • Parameters

                                                                                        • event: "readable"

                                                                                        Returns boolean

                                                                                      • Parameters

                                                                                        • event: "resume"

                                                                                        Returns boolean

                                                                                      • Parameters

                                                                                        Returns boolean

                                                                                      • Parameters

                                                                                        • event: string | symbol
                                                                                        • ...args: any[]

                                                                                        Returns boolean

                                                                                      • Calling the writable.end() method signals that no more data will be written +

                                                                                        Parameters

                                                                                        • event: "close"

                                                                                        Returns boolean

                                                                                        v0.1.26

                                                                                        +

                                                                                      • Parameters

                                                                                        • event: "data"
                                                                                        • chunk: any

                                                                                        Returns boolean

                                                                                      • Parameters

                                                                                        • event: "drain"

                                                                                        Returns boolean

                                                                                      • Parameters

                                                                                        • event: "end"

                                                                                        Returns boolean

                                                                                      • Parameters

                                                                                        • event: "error"
                                                                                        • err: Error

                                                                                        Returns boolean

                                                                                      • Parameters

                                                                                        • event: "finish"

                                                                                        Returns boolean

                                                                                      • Parameters

                                                                                        • event: "pause"

                                                                                        Returns boolean

                                                                                      • Parameters

                                                                                        Returns boolean

                                                                                      • Parameters

                                                                                        • event: "readable"

                                                                                        Returns boolean

                                                                                      • Parameters

                                                                                        • event: "resume"

                                                                                        Returns boolean

                                                                                      • Parameters

                                                                                        Returns boolean

                                                                                      • Parameters

                                                                                        • event: string | symbol
                                                                                        • ...args: any[]

                                                                                        Returns boolean

                                                                                      • Calling the writable.end() method signals that no more data will be written to the Writable. The optional chunk and encoding arguments allow one final additional chunk of data to be written immediately before closing the stream.

                                                                                        @@ -407,8 +410,8 @@ 
                                                                                        // Write 'hello, ' and then end with 'world!'.
                                                                                        import fs from 'node:fs';
                                                                                        const file = fs.createWriteStream('example.txt');
                                                                                        file.write('hello, ');
                                                                                        file.end('world!');
                                                                                        // Writing more now is not allowed!
                                                                                        -

                                                                                        Parameters

                                                                                        • Optionalcb: () => void

                                                                                        Returns this

                                                                                        v0.9.4

                                                                                        -

                                                                                      • Calling the writable.end() method signals that no more data will be written +

                                                                                        Parameters

                                                                                        • Optionalcb: () => void

                                                                                        Returns this

                                                                                        v0.9.4

                                                                                        +

                                                                                      • Calling the writable.end() method signals that no more data will be written to the Writable. The optional chunk and encoding arguments allow one final additional chunk of data to be written immediately before closing the stream.

                                                                                        @@ -418,8 +421,8 @@

                                                                                        Parameters

                                                                                        • chunk: any

                                                                                          Optional data to write. For streams not operating in object mode, chunk must be a {string}, {Buffer}, {TypedArray} or {DataView}. For object mode streams, chunk may be any JavaScript value other than null.

                                                                                          -
                                                                                        • Optionalcb: () => void

                                                                                        Returns this

                                                                                        v0.9.4

                                                                                        -

                                                                                      • Calling the writable.end() method signals that no more data will be written +

                                                                                      • Optionalcb: () => void

                                                                                      Returns this

                                                                                      v0.9.4

                                                                                      +

                                                                                    • Calling the writable.end() method signals that no more data will be written to the Writable. The optional chunk and encoding arguments allow one final additional chunk of data to be written immediately before closing the stream.

                                                                                      @@ -429,51 +432,51 @@

                                                                                      Parameters

                                                                                      • chunk: any

                                                                                        Optional data to write. For streams not operating in object mode, chunk must be a {string}, {Buffer}, {TypedArray} or {DataView}. For object mode streams, chunk may be any JavaScript value other than null.

                                                                                        -
                                                                                      • encoding: BufferEncoding

                                                                                        The encoding if chunk is a string

                                                                                        -
                                                                                      • Optionalcb: () => void

                                                                                      Returns this

                                                                                      v0.9.4

                                                                                      -

                                                                                      • Returns an array listing the events for which the emitter has registered +

                                                                                      • encoding: BufferEncoding

                                                                                        The encoding if chunk is a string

                                                                                        +
                                                                                      • Optionalcb: () => void

                                                                                      Returns this

                                                                                      v0.9.4

                                                                                      +

                                                                                      • Returns an array listing the events for which the emitter has registered listeners. The values in the array are strings or Symbols.

                                                                                        import { EventEmitter } from 'node:events';

                                                                                        const myEE = new EventEmitter();
                                                                                        myEE.on('foo', () => {});
                                                                                        myEE.on('bar', () => {});

                                                                                        const sym = Symbol('symbol');
                                                                                        myEE.on(sym, () => {});

                                                                                        console.log(myEE.eventNames());
                                                                                        // Prints: [ 'foo', 'bar', Symbol(symbol) ]
                                                                                        -

                                                                                        Returns (string | symbol)[]

                                                                                        v6.0.0

                                                                                        -

                                                                                      • This method is similar to Array.prototype.every and calls fn on each chunk in the stream +

                                                                                        Returns (string | symbol)[]

                                                                                        v6.0.0

                                                                                        +

                                                                                      • This method is similar to Array.prototype.every and calls fn on each chunk in the stream to check if all awaited return values are truthy value for fn. Once an fn call on a chunk awaited return value is falsy, the stream is destroyed and the promise is fulfilled with false. If all of the fn calls on the chunks return a truthy value, the promise is fulfilled with true.

                                                                                        Parameters

                                                                                        • fn: (
                                                                                              data: any,
                                                                                              options?: Pick<Stream.ArrayOptions, "signal">,
                                                                                          ) => boolean | Promise<boolean>

                                                                                          a function to call on each chunk of the stream. Async or not.

                                                                                          -
                                                                                        • Optionaloptions: Stream.ArrayOptions

                                                                                        Returns Promise<boolean>

                                                                                        a promise evaluating to true if fn returned a truthy value for every one of the chunks.

                                                                                        -

                                                                                        v17.5.0

                                                                                        -

                                                                                      • This method allows filtering the stream. For each chunk in the stream the fn function will be called +

                                                                                      • Optionaloptions: Stream.ArrayOptions

                                                                                      Returns Promise<boolean>

                                                                                      a promise evaluating to true if fn returned a truthy value for every one of the chunks.

                                                                                      +

                                                                                      v17.5.0

                                                                                      +

                                                                                      • This method allows filtering the stream. For each chunk in the stream the fn function will be called and if it returns a truthy value, the chunk will be passed to the result stream. If the fn function returns a promise - that promise will be awaited.

                                                                                        Parameters

                                                                                        • fn: (
                                                                                              data: any,
                                                                                              options?: Pick<Stream.ArrayOptions, "signal">,
                                                                                          ) => boolean | Promise<boolean>

                                                                                          a function to filter chunks from the stream. Async or not.

                                                                                          -
                                                                                        • Optionaloptions: Stream.ArrayOptions

                                                                                        Returns Readable

                                                                                        a stream filtered with the predicate fn.

                                                                                        -

                                                                                        v17.4.0, v16.14.0

                                                                                        -

                                                                                      • This method is similar to Array.prototype.find and calls fn on each chunk in the stream +

                                                                                      • Optionaloptions: Stream.ArrayOptions

                                                                                      Returns Readable

                                                                                      a stream filtered with the predicate fn.

                                                                                      +

                                                                                      v17.4.0, v16.14.0

                                                                                      +

                                                                                      • This method is similar to Array.prototype.find and calls fn on each chunk in the stream to find a chunk with a truthy value for fn. Once an fn call's awaited return value is truthy, the stream is destroyed and the promise is fulfilled with value for which fn returned a truthy value. If all of the fn calls on the chunks return a falsy value, the promise is fulfilled with undefined.

                                                                                        Type Parameters

                                                                                        • T

                                                                                        Parameters

                                                                                        Returns Promise<T>

                                                                                        a promise evaluating to the first chunk for which fn evaluated with a truthy value, +

                                                                                      • Optionaloptions: Stream.ArrayOptions

                                                                                      Returns Promise<T>

                                                                                      a promise evaluating to the first chunk for which fn evaluated with a truthy value, or undefined if no element was found.

                                                                                      -

                                                                                      v17.5.0

                                                                                      -

                                                                                    • This method is similar to Array.prototype.find and calls fn on each chunk in the stream +

                                                                                      v17.5.0

                                                                                      +

                                                                                    • This method is similar to Array.prototype.find and calls fn on each chunk in the stream to find a chunk with a truthy value for fn. Once an fn call's awaited return value is truthy, the stream is destroyed and the promise is fulfilled with value for which fn returned a truthy value. If all of the fn calls on the chunks return a falsy value, the promise is fulfilled with undefined.

                                                                                      Parameters

                                                                                      • fn: (
                                                                                            data: any,
                                                                                            options?: Pick<Stream.ArrayOptions, "signal">,
                                                                                        ) => boolean | Promise<boolean>

                                                                                        a function to call on each chunk of the stream. Async or not.

                                                                                        -
                                                                                      • Optionaloptions: Stream.ArrayOptions

                                                                                      Returns Promise<any>

                                                                                      a promise evaluating to the first chunk for which fn evaluated with a truthy value, +

                                                                                    • Optionaloptions: Stream.ArrayOptions

                                                                                      • Returns Promise<any>

                                                                                      a promise evaluating to the first chunk for which fn evaluated with a truthy value, or undefined if no element was found.

                                                                                      -

                                                                                      v17.5.0

                                                                                      -

                                                                                      • This method returns a new stream by applying the given callback to each chunk of the stream +

                                                                                        v17.5.0

                                                                                        +

                                                                                      • This method returns a new stream by applying the given callback to each chunk of the stream and then flattening the result.

                                                                                        It is possible to return a stream or another iterable or async iterable from fn and the result streams will be merged (flattened) into the returned stream.

                                                                                        Parameters

                                                                                        • fn: (data: any, options?: Pick<Stream.ArrayOptions, "signal">) => any

                                                                                          a function to map over every chunk in the stream. May be async. May be a stream or generator.

                                                                                          -
                                                                                        • Optionaloptions: Stream.ArrayOptions

                                                                                        Returns Readable

                                                                                        a stream flat-mapped with the function fn.

                                                                                        -

                                                                                        v17.5.0

                                                                                        -

                                                                                      • This method allows iterating a stream. For each chunk in the stream the fn function will be called. +

                                                                                      • Optionaloptions: Stream.ArrayOptions

                                                                                      Returns Readable

                                                                                      a stream flat-mapped with the function fn.

                                                                                      +

                                                                                      v17.5.0

                                                                                      +

                                                                                      • This method allows iterating a stream. For each chunk in the stream the fn function will be called. If the fn function returns a promise - that promise will be awaited.

                                                                                        This method is different from for await...of loops in that it can optionally process chunks concurrently. In addition, a forEach iteration can only be stopped by having passed a signal option @@ -482,44 +485,44 @@

                                                                                        This method is different from listening to the 'data' event in that it uses the readable event in the underlying machinary and can limit the number of concurrent fn calls.

                                                                                        Parameters

                                                                                        • fn: (
                                                                                              data: any,
                                                                                              options?: Pick<Stream.ArrayOptions, "signal">,
                                                                                          ) => void | Promise<void>

                                                                                          a function to call on each chunk of the stream. Async or not.

                                                                                          -
                                                                                        • Optionaloptions: Stream.ArrayOptions

                                                                                        Returns Promise<void>

                                                                                        a promise for when the stream has finished.

                                                                                        -

                                                                                        v17.5.0

                                                                                        -

                                                                                      • Returns the current max listener value for the EventEmitter which is either +

                                                                                      • Optionaloptions: Stream.ArrayOptions

                                                                                      Returns Promise<void>

                                                                                      a promise for when the stream has finished.

                                                                                      +

                                                                                      v17.5.0

                                                                                      +

                                                                                      • Returns the current max listener value for the EventEmitter which is either set by emitter.setMaxListeners(n) or defaults to EventEmitter.defaultMaxListeners.

                                                                                        -

                                                                                        Returns number

                                                                                        v1.0.0

                                                                                        -

                                                                                      • The readable.isPaused() method returns the current operating state of the Readable. +

                                                                                        Returns number

                                                                                        v1.0.0

                                                                                        +

                                                                                      • The readable.isPaused() method returns the current operating state of the Readable. This is used primarily by the mechanism that underlies the readable.pipe() method. In most typical cases, there will be no reason to use this method directly.

                                                                                        const readable = new stream.Readable();

                                                                                        readable.isPaused(); // === false
                                                                                        readable.pause();
                                                                                        readable.isPaused(); // === true
                                                                                        readable.resume();
                                                                                        readable.isPaused(); // === false
                                                                                        -

                                                                                        Returns boolean

                                                                                        v0.11.14

                                                                                        +

                                                                                        Returns boolean

                                                                                        v0.11.14

                                                                                      • The iterator created by this method gives users the option to cancel the destruction of the stream if the for await...of loop is exited by return, break, or throw, or if the iterator should destroy the stream if the stream emitted an error during iteration.

                                                                                        Parameters

                                                                                        • Optionaloptions: { destroyOnReturn?: boolean }
                                                                                          • OptionaldestroyOnReturn?: boolean

                                                                                            When set to false, calling return on the async iterator, or exiting a for await...of iteration using a break, return, or throw will not destroy the stream. Default: true.

                                                                                            -

                                                                                        Returns AsyncIterator<any>

                                                                                        v16.3.0

                                                                                        -

                                                                                      • Returns the number of listeners listening for the event named eventName. +

                                                                                      Returns AsyncIterator<any>

                                                                                      v16.3.0

                                                                                      +

                                                                                      • Returns the number of listeners listening for the event named eventName. If listener is provided, it will return how many times the listener is found in the list of the listeners of the event.

                                                                                        Type Parameters

                                                                                        • K

                                                                                        Parameters

                                                                                        • eventName: string | symbol

                                                                                          The name of the event being listened for

                                                                                          -
                                                                                        • Optionallistener: Function

                                                                                          The event handler function

                                                                                          -

                                                                                        Returns number

                                                                                        v3.2.0

                                                                                        -

                                                                                      • Returns a copy of the array of listeners for the event named eventName.

                                                                                        +
                                                                                      • Optionallistener: Function

                                                                                        The event handler function

                                                                                        +

                                                                                      Returns number

                                                                                      v3.2.0

                                                                                      +

                                                                                      • Returns a copy of the array of listeners for the event named eventName.

                                                                                        server.on('connection', (stream) => {
                                                                                          console.log('someone connected!');
                                                                                        });
                                                                                        console.log(util.inspect(server.listeners('connection')));
                                                                                        // Prints: [ [Function] ]
                                                                                        -

                                                                                        Type Parameters

                                                                                        • K

                                                                                        Parameters

                                                                                        • eventName: string | symbol

                                                                                        Returns Function[]

                                                                                        v0.1.26

                                                                                        -

                                                                                      • This method allows mapping over the stream. The fn function will be called for every chunk in the stream. +

                                                                                        Type Parameters

                                                                                        • K

                                                                                        Parameters

                                                                                        • eventName: string | symbol

                                                                                        Returns Function[]

                                                                                        v0.1.26

                                                                                        +

                                                                                      • This method allows mapping over the stream. The fn function will be called for every chunk in the stream. If the fn function returns a promise - that promise will be awaited before being passed to the result stream.

                                                                                        Parameters

                                                                                        Returns Readable

                                                                                        a stream mapped with the function fn.

                                                                                        -

                                                                                        v17.4.0, v16.14.0

                                                                                        -

                                                                                      • Alias for emitter.removeListener().

                                                                                        -

                                                                                        Type Parameters

                                                                                        • K

                                                                                        Parameters

                                                                                        • eventName: string | symbol
                                                                                        • listener: (...args: any[]) => void

                                                                                        Returns this

                                                                                        v10.0.0

                                                                                        -

                                                                                      • Adds the listener function to the end of the listeners array for the event +

                                                                                      • Optionaloptions: Stream.ArrayOptions

                                                                                      Returns Readable

                                                                                      a stream mapped with the function fn.

                                                                                      +

                                                                                      v17.4.0, v16.14.0

                                                                                      +

                                                                                      • Alias for emitter.removeListener().

                                                                                        +

                                                                                        Type Parameters

                                                                                        • K

                                                                                        Parameters

                                                                                        • eventName: string | symbol
                                                                                        • listener: (...args: any[]) => void

                                                                                        Returns this

                                                                                        v10.0.0

                                                                                        +

                                                                                      • Adds the listener function to the end of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.

                                                                                        @@ -533,8 +536,8 @@

                                                                                        Parameters

                                                                                        • event: "close"
                                                                                        • listener: () => void

                                                                                          The callback function

                                                                                          -

                                                                                        Returns this

                                                                                        v0.1.101

                                                                                        -

                                                                                      • Parameters

                                                                                        • event: "data"
                                                                                        • listener: (chunk: any) => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "drain"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "end"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "error"
                                                                                        • listener: (err: Error) => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "finish"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "pause"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "pipe"
                                                                                        • listener: (src: Readable) => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "readable"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "resume"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "unpipe"
                                                                                        • listener: (src: Readable) => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: string | symbol
                                                                                        • listener: (...args: any[]) => void

                                                                                        Returns this

                                                                                      • Adds a one-time listener function for the event named eventName. The +

                                                                                      Returns this

                                                                                      v0.1.101

                                                                                      +

                                                                                    • Parameters

                                                                                      • event: "data"
                                                                                      • listener: (chunk: any) => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "drain"
                                                                                      • listener: () => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "end"
                                                                                      • listener: () => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "error"
                                                                                      • listener: (err: Error) => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "finish"
                                                                                      • listener: () => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "pause"
                                                                                      • listener: () => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "pipe"
                                                                                      • listener: (src: Readable) => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "readable"
                                                                                      • listener: () => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "resume"
                                                                                      • listener: () => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "unpipe"
                                                                                      • listener: (src: Readable) => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: string | symbol
                                                                                      • listener: (...args: any[]) => void

                                                                                      Returns this

                                                                                      • Adds a one-time listener function for the event named eventName. The next time eventName is triggered, this listener is removed and then invoked.

                                                                                        server.once('connection', (stream) => {
                                                                                          console.log('Ah, we have our first user!');
                                                                                        });
                                                                                        @@ -546,16 +549,16 @@

                                                                                        Parameters

                                                                                        • event: "close"
                                                                                        • listener: () => void

                                                                                          The callback function

                                                                                          -

                                                                                        Returns this

                                                                                        v0.3.0

                                                                                        -

                                                                                      • Parameters

                                                                                        • event: "data"
                                                                                        • listener: (chunk: any) => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "drain"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "end"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "error"
                                                                                        • listener: (err: Error) => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "finish"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "pause"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "pipe"
                                                                                        • listener: (src: Readable) => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "readable"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "resume"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "unpipe"
                                                                                        • listener: (src: Readable) => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: string | symbol
                                                                                        • listener: (...args: any[]) => void

                                                                                        Returns this

                                                                                      • The readable.pause() method will cause a stream in flowing mode to stop +

                                                                                      Returns this

                                                                                      v0.3.0

                                                                                      +

                                                                                    • Parameters

                                                                                      • event: "data"
                                                                                      • listener: (chunk: any) => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "drain"
                                                                                      • listener: () => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "end"
                                                                                      • listener: () => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "error"
                                                                                      • listener: (err: Error) => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "finish"
                                                                                      • listener: () => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "pause"
                                                                                      • listener: () => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "pipe"
                                                                                      • listener: (src: Readable) => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "readable"
                                                                                      • listener: () => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "resume"
                                                                                      • listener: () => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "unpipe"
                                                                                      • listener: (src: Readable) => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: string | symbol
                                                                                      • listener: (...args: any[]) => void

                                                                                      Returns this

                                                                                      • The readable.pause() method will cause a stream in flowing mode to stop emitting 'data' events, switching out of flowing mode. Any data that becomes available will remain in the internal buffer.

                                                                                        const readable = getReadableStreamSomehow();
                                                                                        readable.on('data', (chunk) => {
                                                                                          console.log(`Received ${chunk.length} bytes of data.`);
                                                                                          readable.pause();
                                                                                          console.log('There will be no additional data for 1 second.');
                                                                                          setTimeout(() => {
                                                                                            console.log('Now data will start flowing again.');
                                                                                            readable.resume();
                                                                                          }, 1000);
                                                                                        });

                                                                                        The readable.pause() method has no effect if there is a 'readable' event listener.

                                                                                        -

                                                                                        Returns this

                                                                                        v0.9.4

                                                                                        -

                                                                                      • Type Parameters

                                                                                        Parameters

                                                                                        • destination: T
                                                                                        • Optionaloptions: { end?: boolean }

                                                                                        Returns T

                                                                                      • Adds the listener function to the beginning of the listeners array for the +

                                                                                        Returns this

                                                                                        v0.9.4

                                                                                        +

                                                                                      • Type Parameters

                                                                                        Parameters

                                                                                        • destination: T
                                                                                        • Optionaloptions: { end?: boolean }

                                                                                        Returns T

                                                                                      • Adds the listener function to the beginning of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.

                                                                                        @@ -564,22 +567,22 @@

                                                                                        Returns a reference to the EventEmitter, so that calls can be chained.

                                                                                        Parameters

                                                                                        • event: "close"
                                                                                        • listener: () => void

                                                                                          The callback function

                                                                                          -

                                                                                        Returns this

                                                                                        v6.0.0

                                                                                        -

                                                                                      • Parameters

                                                                                        • event: "data"
                                                                                        • listener: (chunk: any) => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "drain"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "end"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "error"
                                                                                        • listener: (err: Error) => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "finish"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "pause"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "pipe"
                                                                                        • listener: (src: Readable) => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "readable"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "resume"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "unpipe"
                                                                                        • listener: (src: Readable) => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: string | symbol
                                                                                        • listener: (...args: any[]) => void

                                                                                        Returns this

                                                                                      • Adds a one-timelistener function for the event named eventName to the beginning of the listeners array. The next time eventName is triggered, this +

                                                                                      Returns this

                                                                                      v6.0.0

                                                                                      +

                                                                                    • Parameters

                                                                                      • event: "data"
                                                                                      • listener: (chunk: any) => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "drain"
                                                                                      • listener: () => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "end"
                                                                                      • listener: () => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "error"
                                                                                      • listener: (err: Error) => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "finish"
                                                                                      • listener: () => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "pause"
                                                                                      • listener: () => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "pipe"
                                                                                      • listener: (src: Readable) => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "readable"
                                                                                      • listener: () => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "resume"
                                                                                      • listener: () => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "unpipe"
                                                                                      • listener: (src: Readable) => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: string | symbol
                                                                                      • listener: (...args: any[]) => void

                                                                                      Returns this

                                                                                      • Adds a one-timelistener function for the event named eventName to the beginning of the listeners array. The next time eventName is triggered, this listener is removed, and then invoked.

                                                                                        server.prependOnceListener('connection', (stream) => {
                                                                                          console.log('Ah, we have our first user!');
                                                                                        });

                                                                                        Returns a reference to the EventEmitter, so that calls can be chained.

                                                                                        Parameters

                                                                                        • event: "close"
                                                                                        • listener: () => void

                                                                                          The callback function

                                                                                          -

                                                                                        Returns this

                                                                                        v6.0.0

                                                                                        -

                                                                                      • Parameters

                                                                                        • event: "data"
                                                                                        • listener: (chunk: any) => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "drain"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "end"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "error"
                                                                                        • listener: (err: Error) => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "finish"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "pause"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "pipe"
                                                                                        • listener: (src: Readable) => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "readable"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "resume"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "unpipe"
                                                                                        • listener: (src: Readable) => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: string | symbol
                                                                                        • listener: (...args: any[]) => void

                                                                                        Returns this

                                                                                      • Returns a copy of the array of listeners for the event named eventName, +

                                                                                      Returns this

                                                                                      v6.0.0

                                                                                      +

                                                                                    • Parameters

                                                                                      • event: "data"
                                                                                      • listener: (chunk: any) => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "drain"
                                                                                      • listener: () => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "end"
                                                                                      • listener: () => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "error"
                                                                                      • listener: (err: Error) => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "finish"
                                                                                      • listener: () => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "pause"
                                                                                      • listener: () => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "pipe"
                                                                                      • listener: (src: Readable) => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "readable"
                                                                                      • listener: () => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "resume"
                                                                                      • listener: () => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "unpipe"
                                                                                      • listener: (src: Readable) => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: string | symbol
                                                                                      • listener: (...args: any[]) => void

                                                                                      Returns this

                                                                                      • Returns a copy of the array of listeners for the event named eventName, including any wrappers (such as those created by .once()).

                                                                                        import { EventEmitter } from 'node:events';
                                                                                        const emitter = new EventEmitter();
                                                                                        emitter.once('log', () => console.log('log once'));

                                                                                        // Returns a new Array with a function `onceWrapper` which has a property
                                                                                        // `listener` which contains the original listener bound above
                                                                                        const listeners = emitter.rawListeners('log');
                                                                                        const logFnWrapper = listeners[0];

                                                                                        // Logs "log once" to the console and does not unbind the `once` event
                                                                                        logFnWrapper.listener();

                                                                                        // Logs "log once" to the console and removes the listener
                                                                                        logFnWrapper();

                                                                                        emitter.on('log', () => console.log('log persistently'));
                                                                                        // Will return a new Array with a single function bound by `.on()` above
                                                                                        const newListeners = emitter.rawListeners('log');

                                                                                        // Logs "log persistently" twice
                                                                                        newListeners[0]();
                                                                                        emitter.emit('log');
                                                                                        -

                                                                                        Type Parameters

                                                                                        • K

                                                                                        Parameters

                                                                                        • eventName: string | symbol

                                                                                        Returns Function[]

                                                                                        v9.4.0

                                                                                        -

                                                                                      • The readable.read() method reads data out of the internal buffer and +

                                                                                        Type Parameters

                                                                                        • K

                                                                                        Parameters

                                                                                        • eventName: string | symbol

                                                                                        Returns Function[]

                                                                                        v9.4.0

                                                                                        +

                                                                                      • The readable.read() method reads data out of the internal buffer and returns it. If no data is available to be read, null is returned. By default, the data is returned as a Buffer object unless an encoding has been specified using the readable.setEncoding() method or the stream is operating @@ -616,7 +619,7 @@

                                                                                        Calling read after the 'end' event has been emitted will return null. No runtime error will be raised.

                                                                                        Parameters

                                                                                        • Optionalsize: number

                                                                                          Optional argument to specify how much data to read.

                                                                                          -

                                                                                        Returns any

                                                                                        v0.9.4

                                                                                        +

                                                                                      Returns any

                                                                                      v0.9.4

                                                                                      • This method calls fn on each chunk of the stream in order, passing it the result from the calculation on the previous element. It returns a promise for the final value of the reduction.

                                                                                        If no initial value is supplied the first chunk of the stream is used as the initial value. @@ -624,26 +627,26 @@

                                                                                        The reducer function iterates the stream element-by-element which means that there is no concurrency parameter or parallelism. To perform a reduce concurrently, you can extract the async function to readable.map method.

                                                                                        Type Parameters

                                                                                        • T = any

                                                                                        Parameters

                                                                                        • fn: (previous: any, data: any, options?: Pick<Stream.ArrayOptions, "signal">) => T

                                                                                          a reducer function to call over every chunk in the stream. Async or not.

                                                                                          -
                                                                                        • Optionalinitial: undefined

                                                                                          the initial value to use in the reduction.

                                                                                          -
                                                                                        • Optionaloptions: Pick<Stream.ArrayOptions, "signal">

                                                                                        Returns Promise<T>

                                                                                        a promise for the final value of the reduction.

                                                                                        -

                                                                                        v17.5.0

                                                                                        -

                                                                                      • This method calls fn on each chunk of the stream in order, passing it the result from the calculation +

                                                                                      • Optionalinitial: undefined

                                                                                        the initial value to use in the reduction.

                                                                                        +
                                                                                      • Optionaloptions: Pick<Stream.ArrayOptions, "signal">

                                                                                      Returns Promise<T>

                                                                                      a promise for the final value of the reduction.

                                                                                      +

                                                                                      v17.5.0

                                                                                      +

                                                                                    • This method calls fn on each chunk of the stream in order, passing it the result from the calculation on the previous element. It returns a promise for the final value of the reduction.

                                                                                      If no initial value is supplied the first chunk of the stream is used as the initial value. If the stream is empty, the promise is rejected with a TypeError with the ERR_INVALID_ARGS code property.

                                                                                      The reducer function iterates the stream element-by-element which means that there is no concurrency parameter or parallelism. To perform a reduce concurrently, you can extract the async function to readable.map method.

                                                                                      Type Parameters

                                                                                      • T = any

                                                                                      Parameters

                                                                                      • fn: (previous: T, data: any, options?: Pick<Stream.ArrayOptions, "signal">) => T

                                                                                        a reducer function to call over every chunk in the stream. Async or not.

                                                                                        -
                                                                                      • initial: T

                                                                                        the initial value to use in the reduction.

                                                                                        -
                                                                                      • Optionaloptions: Pick<Stream.ArrayOptions, "signal">

                                                                                      Returns Promise<T>

                                                                                      a promise for the final value of the reduction.

                                                                                      -

                                                                                      v17.5.0

                                                                                      -

                                                                                      • Removes all listeners, or those of the specified eventName.

                                                                                        +
                                                                                      • initial: T

                                                                                        the initial value to use in the reduction.

                                                                                        +
                                                                                      • Optionaloptions: Pick<Stream.ArrayOptions, "signal">

                                                                                      Returns Promise<T>

                                                                                      a promise for the final value of the reduction.

                                                                                      +

                                                                                      v17.5.0

                                                                                      +

                                                                                      • Removes all listeners, or those of the specified eventName.

                                                                                        It is bad practice to remove listeners added elsewhere in the code, particularly when the EventEmitter instance was created by some other component or module (e.g. sockets or file streams).

                                                                                        Returns a reference to the EventEmitter, so that calls can be chained.

                                                                                        -

                                                                                        Parameters

                                                                                        • OptionaleventName: string | symbol

                                                                                        Returns this

                                                                                        v0.1.26

                                                                                        -

                                                                                      • Removes the specified listener from the listener array for the event named eventName.

                                                                                        +

                                                                                        Parameters

                                                                                        • OptionaleventName: string | symbol

                                                                                        Returns this

                                                                                        v0.1.26

                                                                                        +

                                                                                      • Removes the specified listener from the listener array for the event named eventName.

                                                                                        const callback = (stream) => {
                                                                                          console.log('someone connected!');
                                                                                        };
                                                                                        server.on('connection', callback);
                                                                                        // ...
                                                                                        server.removeListener('connection', callback);
                                                                                        @@ -669,8 +672,8 @@

                                                                                        Returns a reference to the EventEmitter, so that calls can be chained.

                                                                                        -

                                                                                        Parameters

                                                                                        • event: "close"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                        v0.1.26

                                                                                        -

                                                                                      • Parameters

                                                                                        • event: "data"
                                                                                        • listener: (chunk: any) => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "drain"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "end"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "error"
                                                                                        • listener: (err: Error) => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "finish"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "pause"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "pipe"
                                                                                        • listener: (src: Readable) => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "readable"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "resume"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "unpipe"
                                                                                        • listener: (src: Readable) => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: string | symbol
                                                                                        • listener: (...args: any[]) => void

                                                                                        Returns this

                                                                                      • The readable.resume() method causes an explicitly paused Readable stream to +

                                                                                        Parameters

                                                                                        • event: "close"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                        v0.1.26

                                                                                        +

                                                                                      • Parameters

                                                                                        • event: "data"
                                                                                        • listener: (chunk: any) => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "drain"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "end"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "error"
                                                                                        • listener: (err: Error) => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "finish"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "pause"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "pipe"
                                                                                        • listener: (src: Readable) => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "readable"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "resume"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "unpipe"
                                                                                        • listener: (src: Readable) => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: string | symbol
                                                                                        • listener: (...args: any[]) => void

                                                                                        Returns this

                                                                                      • The readable.resume() method causes an explicitly paused Readable stream to resume emitting 'data' events, switching the stream into flowing mode.

                                                                                        The readable.resume() method can be used to fully consume the data from a stream without actually processing any of that data:

                                                                                        @@ -678,11 +681,11 @@

                                                                                        The readable.resume() method has no effect if there is a 'readable' event listener.

                                                                                        -

                                                                                        Returns this

                                                                                        v0.9.4

                                                                                        -

                                                                                      • The writable.setDefaultEncoding() method sets the default encoding for a Writable stream.

                                                                                        +

                                                                                        Returns this

                                                                                        v0.9.4

                                                                                        +

                                                                                      • The writable.setDefaultEncoding() method sets the default encoding for a Writable stream.

                                                                                        Parameters

                                                                                        Returns this

                                                                                        v0.11.15

                                                                                        -

                                                                                      • The readable.setEncoding() method sets the character encoding for +

                                                                                      Returns this

                                                                                      v0.11.15

                                                                                      +

                                                                                      • The readable.setEncoding() method sets the character encoding for data read from the Readable stream.

                                                                                        By default, no encoding is assigned and stream data will be returned as Buffer objects. Setting an encoding causes the stream data to be returned as strings of the specified encoding rather than as Buffer objects. For instance, calling readable.setEncoding('utf8') will cause the @@ -695,29 +698,29 @@

                                                                                        Parameters

                                                                                        Returns this

                                                                                        v0.9.4

                                                                                        -

                                                                                      • By default EventEmitters will print a warning if more than 10 listeners are +

                                                                                      Returns this

                                                                                      v0.9.4

                                                                                      +

                                                                                      • By default EventEmitters will print a warning if more than 10 listeners are added for a particular event. This is a useful default that helps finding memory leaks. The emitter.setMaxListeners() method allows the limit to be modified for this specific EventEmitter instance. The value can be set to Infinity (or 0) to indicate an unlimited number of listeners.

                                                                                        Returns a reference to the EventEmitter, so that calls can be chained.

                                                                                        -

                                                                                        Parameters

                                                                                        • n: number

                                                                                        Returns this

                                                                                        v0.3.5

                                                                                        -

                                                                                      • This method is similar to Array.prototype.some and calls fn on each chunk in the stream +

                                                                                        Parameters

                                                                                        • n: number

                                                                                        Returns this

                                                                                        v0.3.5

                                                                                        +

                                                                                      • This method is similar to Array.prototype.some and calls fn on each chunk in the stream until the awaited return value is true (or any truthy value). Once an fn call on a chunk awaited return value is truthy, the stream is destroyed and the promise is fulfilled with true. If none of the fn calls on the chunks return a truthy value, the promise is fulfilled with false.

                                                                                        Parameters

                                                                                        • fn: (
                                                                                              data: any,
                                                                                              options?: Pick<Stream.ArrayOptions, "signal">,
                                                                                          ) => boolean | Promise<boolean>

                                                                                          a function to call on each chunk of the stream. Async or not.

                                                                                          -
                                                                                        • Optionaloptions: Stream.ArrayOptions

                                                                                        Returns Promise<boolean>

                                                                                        a promise evaluating to true if fn returned a truthy value for at least one of the chunks.

                                                                                        -

                                                                                        v17.5.0

                                                                                        -

                                                                                      Returns Promise<boolean>

                                                                                      a promise evaluating to true if fn returned a truthy value for at least one of the chunks.

                                                                                      v17.5.0

                                                                                      +

                                                                                      • This method returns a new stream with the first limit chunks.

                                                                                        +

                                                                                        Parameters

                                                                                        • limit: number

                                                                                          the number of chunks to take from the readable.

                                                                                          +
                                                                                        • Optionaloptions: Pick<Stream.ArrayOptions, "signal">

                                                                                        Returns Readable

                                                                                        a stream with limit chunks taken.

                                                                                        +

                                                                                        v17.5.0

                                                                                      • This method allows easily obtaining the contents of a stream.

                                                                                        As this method reads the entire stream into memory, it negates the benefits of streams. It's intended for interoperability and convenience, not as the primary way to consume streams.

                                                                                        Parameters

                                                                                        Returns Promise<any[]>

                                                                                        a promise containing an array with the contents of the stream.

                                                                                        -

                                                                                        v17.5.0

                                                                                        +

                                                                                        v17.5.0

                                                                                      • The writable.uncork() method flushes all data buffered since cork was called.

                                                                                        When using writable.cork() and writable.uncork() to manage the buffering of writes to a stream, defer calls to writable.uncork() using process.nextTick(). Doing so allows batching of all writable.write() calls that occur within a given Node.js event @@ -732,8 +735,8 @@

                                                                                        See also: writable.cork().

                                                                                        -

                                                                                        Returns void

                                                                                        v0.11.2

                                                                                        -

                                                                                      • The readable.unpipe() method detaches a Writable stream previously attached +

                                                                                        Returns void

                                                                                        v0.11.2

                                                                                        +

                                                                                      • The readable.unpipe() method detaches a Writable stream previously attached using the pipe method.

                                                                                        If the destination is not specified, then all pipes are detached.

                                                                                        If the destination is specified, but no pipe is set up for it, then @@ -742,8 +745,8 @@

                                                                                        Parameters

                                                                                        • Optionaldestination: WritableStream

                                                                                          Optional specific stream to unpipe

                                                                                          -

                                                                                        Returns this

                                                                                        v0.9.4

                                                                                        -

                                                                                      • Passing chunk as null signals the end of the stream (EOF) and behaves the +

                                                                                      Returns this

                                                                                      v0.9.4

                                                                                      +

                                                                                      • Passing chunk as null signals the end of the stream (EOF) and behaves the same as readable.push(null), after which no more data can be written. The EOF signal is put at the end of the buffer and any buffered data will still be flushed.

                                                                                        @@ -767,8 +770,8 @@ process of performing a read.

                                                                                        Parameters

                                                                                        • chunk: any

                                                                                          Chunk of data to unshift onto the read queue. For streams not operating in object mode, chunk must be a {string}, {Buffer}, {TypedArray}, {DataView} or null. For object mode streams, chunk may be any JavaScript value.

                                                                                          -
                                                                                        • Optionalencoding: BufferEncoding

                                                                                          Encoding of string chunks. Must be a valid Buffer encoding, such as 'utf8' or 'ascii'.

                                                                                          -

                                                                                        Returns void

                                                                                        v0.9.11

                                                                                        +
                                                                                      • Optionalencoding: BufferEncoding

                                                                                        Encoding of string chunks. Must be a valid Buffer encoding, such as 'utf8' or 'ascii'.

                                                                                        +

                                                                                      Returns void

                                                                                      v0.9.11

                                                                                      • Prior to Node.js 0.10, streams did not implement the entire node:stream module API as it is currently defined. (See Compatibility for more information.)

                                                                                        When using an older Node.js library that emits 'data' events and has a pause method that is advisory only, the readable.wrap() method can be used to create a Readable @@ -781,8 +784,8 @@

                                                                                        Parameters

                                                                                        Returns this

                                                                                        v0.9.4

                                                                                        -

                                                                                      • The writable.write() method writes some data to the stream, and calls the +

                                                                                      Returns this

                                                                                      v0.9.4

                                                                                      +

                                                                                      • The writable.write() method writes some data to the stream, and calls the supplied callback once the data has been fully handled. If an error occurs, the callback will be called with the error as its first argument. The callback is called asynchronously and before 'error' is @@ -815,10 +818,10 @@

                                                                                        A Writable stream in object mode will always ignore the encoding argument.

                                                                                        Parameters

                                                                                        • chunk: any

                                                                                          Optional data to write. For streams not operating in object mode, chunk must be a {string}, {Buffer}, {TypedArray} or {DataView}. For object mode streams, chunk may be any JavaScript value other than null.

                                                                                          -
                                                                                        • Optionalcallback: (error: Error) => void

                                                                                          Callback for when this chunk of data is flushed.

                                                                                          -

                                                                                        Returns boolean

                                                                                        false if the stream wishes for the calling code to wait for the 'drain' event to be emitted before continuing to write additional data; otherwise true.

                                                                                        -

                                                                                        v0.9.4

                                                                                        -

                                                                                      • The writable.write() method writes some data to the stream, and calls the +

                                                                                      • Optionalcallback: (error: Error) => void

                                                                                        Callback for when this chunk of data is flushed.

                                                                                        +

                                                                                      Returns boolean

                                                                                      false if the stream wishes for the calling code to wait for the 'drain' event to be emitted before continuing to write additional data; otherwise true.

                                                                                      +

                                                                                      v0.9.4

                                                                                      +

                                                                                    • The writable.write() method writes some data to the stream, and calls the supplied callback once the data has been fully handled. If an error occurs, the callback will be called with the error as its first argument. The callback is called asynchronously and before 'error' is @@ -851,11 +854,11 @@

                                                                                      A Writable stream in object mode will always ignore the encoding argument.

                                                                                      Parameters

                                                                                      • chunk: any

                                                                                        Optional data to write. For streams not operating in object mode, chunk must be a {string}, {Buffer}, {TypedArray} or {DataView}. For object mode streams, chunk may be any JavaScript value other than null.

                                                                                        -
                                                                                      • encoding: BufferEncoding

                                                                                        The encoding, if chunk is a string.

                                                                                        -
                                                                                      • Optionalcallback: (error: Error) => void

                                                                                        Callback for when this chunk of data is flushed.

                                                                                        -

                                                                                      Returns boolean

                                                                                      false if the stream wishes for the calling code to wait for the 'drain' event to be emitted before continuing to write additional data; otherwise true.

                                                                                      -

                                                                                      v0.9.4

                                                                                      -

                                                                                      • Listens once to the abort event on the provided signal.

                                                                                        +
                                                                                      • encoding: BufferEncoding

                                                                                        The encoding, if chunk is a string.

                                                                                        +
                                                                                      • Optionalcallback: (error: Error) => void

                                                                                        Callback for when this chunk of data is flushed.

                                                                                        +

                                                                                      Returns boolean

                                                                                      false if the stream wishes for the calling code to wait for the 'drain' event to be emitted before continuing to write additional data; otherwise true.

                                                                                      +

                                                                                      v0.9.4

                                                                                      +

                                                                                      • Listens once to the abort event on the provided signal.

                                                                                        Listening to the abort event on abort signals is unsafe and may lead to resource leaks since another third party with the signal can call e.stopImmediatePropagation(). Unfortunately Node.js cannot change @@ -869,8 +872,8 @@

                                                                                        Parameters

                                                                                        Returns Disposable

                                                                                        Disposable that removes the abort listener.

                                                                                        -

                                                                                        v20.5.0

                                                                                        -

                                                                                      • A utility method for creating duplex streams.

                                                                                        +

                                                                                        v20.5.0

                                                                                        +

                                                                                      • A utility method for creating duplex streams.

                                                                                        • Stream converts writable stream into writable Duplex and readable stream to Duplex.
                                                                                          • @@ -888,10 +891,10 @@ Duplex will write to the writable and read from the readable.
                                                                                        • Promise converts into readable Duplex. Value null is ignored.
                                                                                        -

                                                                                        Parameters

                                                                                        Returns Duplex

                                                                                        v16.8.0

                                                                                        -

                                                                                      • A utility method for creating a Duplex from a web ReadableStream and WritableStream.

                                                                                        -

                                                                                        Parameters

                                                                                        • duplexStream: { readable: ReadableStream; writable: WritableStream }
                                                                                        • Optionaloptions: Pick<
                                                                                              DuplexOptions,
                                                                                              | "allowHalfOpen"
                                                                                              | "decodeStrings"
                                                                                              | "encoding"
                                                                                              | "highWaterMark"
                                                                                              | "objectMode"
                                                                                              | "signal",
                                                                                          >

                                                                                        Returns Duplex

                                                                                        v17.0.0

                                                                                        -

                                                                                      • Returns a copy of the array of listeners for the event named eventName.

                                                                                        +

                                                                                        Parameters

                                                                                        Returns Duplex

                                                                                        v16.8.0

                                                                                        +

                                                                                      • A utility method for creating a Duplex from a web ReadableStream and WritableStream.

                                                                                        +

                                                                                        Parameters

                                                                                        • duplexStream: { readable: ReadableStream; writable: WritableStream }
                                                                                        • Optionaloptions: Pick<
                                                                                              DuplexOptions,
                                                                                              | "allowHalfOpen"
                                                                                              | "decodeStrings"
                                                                                              | "encoding"
                                                                                              | "highWaterMark"
                                                                                              | "objectMode"
                                                                                              | "signal",
                                                                                          >

                                                                                        Returns Duplex

                                                                                        v17.0.0

                                                                                        +

                                                                                      • Returns a copy of the array of listeners for the event named eventName.

                                                                                        For EventEmitters this behaves exactly the same as calling .listeners on the emitter.

                                                                                        For EventTargets this is the only way to get the event listeners for the @@ -899,8 +902,8 @@ 

                                                                                        import { getEventListeners, EventEmitter } from 'node:events';

                                                                                        {
                                                                                          const ee = new EventEmitter();
                                                                                          const listener = () => console.log('Events are fun');
                                                                                          ee.on('foo', listener);
                                                                                          console.log(getEventListeners(ee, 'foo')); // [ [Function: listener] ]
                                                                                        }
                                                                                        {
                                                                                          const et = new EventTarget();
                                                                                          const listener = () => console.log('Events are fun');
                                                                                          et.addEventListener('foo', listener);
                                                                                          console.log(getEventListeners(et, 'foo')); // [ [Function: listener] ]
                                                                                        }
                                                                                        -

                                                                                        Parameters

                                                                                        Returns Function[]

                                                                                        v15.2.0, v14.17.0

                                                                                        -

                                                                                      • Returns the currently set max amount of listeners.

                                                                                        For EventEmitters this behaves exactly the same as calling .getMaxListeners on the emitter.

                                                                                        For EventTargets this is the only way to get the max event listeners for the @@ -909,16 +912,16 @@ 

                                                                                        import { getMaxListeners, setMaxListeners, EventEmitter } from 'node:events';

                                                                                        {
                                                                                          const ee = new EventEmitter();
                                                                                          console.log(getMaxListeners(ee)); // 10
                                                                                          setMaxListeners(11, ee);
                                                                                          console.log(getMaxListeners(ee)); // 11
                                                                                        }
                                                                                        {
                                                                                          const et = new EventTarget();
                                                                                          console.log(getMaxListeners(et)); // 10
                                                                                          setMaxListeners(11, et);
                                                                                          console.log(getMaxListeners(et)); // 11
                                                                                        }
                                                                                        -

                                                                                        Parameters

                                                                                        Returns number

                                                                                        v19.9.0

                                                                                        -

                                                                                      • A class method that returns the number of listeners for the given eventName registered on the given emitter.

                                                                                        import { EventEmitter, listenerCount } from 'node:events';

                                                                                        const myEmitter = new EventEmitter();
                                                                                        myEmitter.on('event', () => {});
                                                                                        myEmitter.on('event', () => {});
                                                                                        console.log(listenerCount(myEmitter, 'event'));
                                                                                        // Prints: 2

                                                                                        Parameters

                                                                                        • emitter: EventEmitter

                                                                                          The emitter to query

                                                                                          -
                                                                                        • eventName: string | symbol

                                                                                          The event name

                                                                                          -

                                                                                        Returns number

                                                                                        v0.9.12

                                                                                        +
                                                                                      • eventName: string | symbol

                                                                                        The event name

                                                                                        +

                                                                                      Returns number

                                                                                      v0.9.12

                                                                                      Since v3.2.0 - Use listenerCount instead.

                                                                                      -
                                                                                      • import { on, EventEmitter } from 'node:events';
                                                                                        import process from 'node:process';

                                                                                        const ee = new EventEmitter();

                                                                                        // Emit later on
                                                                                        process.nextTick(() => {
                                                                                          ee.emit('foo', 'bar');
                                                                                          ee.emit('foo', 42);
                                                                                        });

                                                                                        for await (const event of on(ee, 'foo')) {
                                                                                          // The execution of this inner block is synchronous and it
                                                                                          // processes one event at a time (even with await). Do not use
                                                                                          // if concurrent execution is required.
                                                                                          console.log(event); // prints ['bar'] [42]
                                                                                        }
                                                                                        // Unreachable here
+
                                                                                      • import { on, EventEmitter } from 'node:events';
                                                                                        import process from 'node:process';

                                                                                        const ee = new EventEmitter();

                                                                                        // Emit later on
                                                                                        process.nextTick(() => {
                                                                                          ee.emit('foo', 'bar');
                                                                                          ee.emit('foo', 42);
                                                                                        });

                                                                                        for await (const event of on(ee, 'foo')) {
                                                                                          // The execution of this inner block is synchronous and it
                                                                                          // processes one event at a time (even with await). Do not use
                                                                                          // if concurrent execution is required.
                                                                                          console.log(event); // prints ['bar'] [42]
                                                                                        }
                                                                                        // Unreachable here

                                                                                        Returns an AsyncIterator that iterates eventName events. It will throw @@ -934,8 +937,8 @@

                                                                                        Parameters

                                                                                        Returns AsyncIterator<any[]>

                                                                                        An AsyncIterator that iterates eventName events emitted by the emitter

                                                                                        -

                                                                                        v13.6.0, v12.16.0

                                                                                        -
                                                                                      • import { on, EventEmitter } from 'node:events';
                                                                                        import process from 'node:process';

                                                                                        const ee = new EventEmitter();

                                                                                        // Emit later on
                                                                                        process.nextTick(() => {
                                                                                          ee.emit('foo', 'bar');
                                                                                          ee.emit('foo', 42);
                                                                                        });

                                                                                        for await (const event of on(ee, 'foo')) {
                                                                                          // The execution of this inner block is synchronous and it
                                                                                          // processes one event at a time (even with await). Do not use
                                                                                          // if concurrent execution is required.
                                                                                          console.log(event); // prints ['bar'] [42]
                                                                                        }
                                                                                        // Unreachable here
+
                                                                                        v13.6.0, v12.16.0
                                                                                        
+
                                                                                      • import { on, EventEmitter } from 'node:events';
                                                                                        import process from 'node:process';

                                                                                        const ee = new EventEmitter();

                                                                                        // Emit later on
                                                                                        process.nextTick(() => {
                                                                                          ee.emit('foo', 'bar');
                                                                                          ee.emit('foo', 42);
                                                                                        });

                                                                                        for await (const event of on(ee, 'foo')) {
                                                                                          // The execution of this inner block is synchronous and it
                                                                                          // processes one event at a time (even with await). Do not use
                                                                                          // if concurrent execution is required.
                                                                                          console.log(event); // prints ['bar'] [42]
                                                                                        }
                                                                                        // Unreachable here

                                                                                        Returns an AsyncIterator that iterates eventName events. It will throw @@ -951,8 +954,8 @@

                                                                                        Parameters

                                                                                        Returns AsyncIterator<any[]>

                                                                                        An AsyncIterator that iterates eventName events emitted by the emitter

                                                                                        -

                                                                                        v13.6.0, v12.16.0

                                                                                        -

                                                                                      • Creates a Promise that is fulfilled when the EventEmitter emits the given +

                                                                                        v13.6.0, v12.16.0

                                                                                        +

                                                                                      • Creates a Promise that is fulfilled when the EventEmitter emits the given event or that is rejected if the EventEmitter emits 'error' while waiting. The Promise will resolve with an array of all the arguments emitted to the given event.

                                                                                        @@ -971,8 +974,8 @@ 
                                                                                        import { EventEmitter, once } from 'node:events';

                                                                                        const ee = new EventEmitter();
                                                                                        const ac = new AbortController();

                                                                                        async function foo(emitter, event, signal) {
                                                                                          try {
                                                                                            await once(emitter, event, { signal });
                                                                                            console.log('event emitted!');
                                                                                          } catch (error) {
                                                                                            if (error.name === 'AbortError') {
                                                                                              console.error('Waiting for the event was canceled!');
                                                                                            } else {
                                                                                              console.error('There was an error', error.message);
                                                                                            }
                                                                                          }
                                                                                        }

                                                                                        foo(ee, 'foo', ac.signal);
                                                                                        ac.abort(); // Abort waiting for the event
                                                                                        ee.emit('foo'); // Prints: Waiting for the event was canceled!
                                                                                        -

                                                                                        Parameters

                                                                                        Returns Promise<any[]>

                                                                                        v11.13.0, v10.16.0

                                                                                        -

                                                                                      • Creates a Promise that is fulfilled when the EventEmitter emits the given +

                                                                                        Parameters

                                                                                        Returns Promise<any[]>

                                                                                        v11.13.0, v10.16.0

                                                                                        +

                                                                                      • Creates a Promise that is fulfilled when the EventEmitter emits the given event or that is rejected if the EventEmitter emits 'error' while waiting. The Promise will resolve with an array of all the arguments emitted to the given event.

                                                                                        @@ -991,14 +994,14 @@ 
                                                                                        import { EventEmitter, once } from 'node:events';

                                                                                        const ee = new EventEmitter();
                                                                                        const ac = new AbortController();

                                                                                        async function foo(emitter, event, signal) {
                                                                                          try {
                                                                                            await once(emitter, event, { signal });
                                                                                            console.log('event emitted!');
                                                                                          } catch (error) {
                                                                                            if (error.name === 'AbortError') {
                                                                                              console.error('Waiting for the event was canceled!');
                                                                                            } else {
                                                                                              console.error('There was an error', error.message);
                                                                                            }
                                                                                          }
                                                                                        }

                                                                                        foo(ee, 'foo', ac.signal);
                                                                                        ac.abort(); // Abort waiting for the event
                                                                                        ee.emit('foo'); // Prints: Waiting for the event was canceled!
                                                                                        -

                                                                                        Parameters

                                                                                        Returns Promise<any[]>

                                                                                        v11.13.0, v10.16.0

                                                                                        -
                                                                                      • import { setMaxListeners, EventEmitter } from 'node:events';

                                                                                        const target = new EventTarget();
                                                                                        const emitter = new EventEmitter();

                                                                                        setMaxListeners(5, target, emitter);
+

                                                                                        Parameters

                                                                                        Returns Promise<any[]>

                                                                                        v11.13.0, v10.16.0

                                                                                        +
                                                                                      • import { setMaxListeners, EventEmitter } from 'node:events';

                                                                                        const target = new EventTarget();
                                                                                        const emitter = new EventEmitter();

                                                                                        setMaxListeners(5, target, emitter);

                                                                                        Parameters

                                                                                        • Optionaln: number

                                                                                          A non-negative number. The maximum number of listeners per EventTarget event.

                                                                                          -
                                                                                        • ...eventTargets: (EventEmitter<DefaultEventMap> | EventTarget)[]

                                                                                          Zero or more {EventTarget} or {EventEmitter} instances. If none are specified, n is set as the default max for all newly created {EventTarget} and {EventEmitter} +

                                                                                        • ...eventTargets: (EventEmitter<DefaultEventMap> | EventTarget)[]

                                                                                          Zero or more {EventTarget} or {EventEmitter} instances. If none are specified, n is set as the default max for all newly created {EventTarget} and {EventEmitter} objects.

                                                                                          -

                                                                                        Returns void

                                                                                        v15.4.0

                                                                                        -

                                                                                      Settings

                                                                                      Member Visibility

                                                                                      On This Page

                                                                                      Constructors
                                                                                      Properties
                                                                                      Methods
                                                                                      +

                                                                                      Returns void

                                                                                      v15.4.0

                                                                                      +

                                                                                      Settings

                                                                                      Member Visibility

                                                                                      On This Page

                                                                                      Constructors
                                                                                      Properties
                                                                                      Methods
                                                                                      diff --git a/docs/classes/_internal_.Stream.Transform.html b/docs/classes/_internal_.Stream.Transform.html index 388b6fbf..85e74d2c 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 @@ -100,13 +100,13 @@ once setMaxListeners toWeb -

                                                                                      Constructors

                                                                                      Properties

                                                                                      allowHalfOpen: boolean

                                                                                      If false then the stream will automatically end the writable side when the +

                                                                                      Constructors

                                                                                      Properties

                                                                                      allowHalfOpen: boolean

                                                                                      If false then the stream will automatically end the writable side when the readable side ends. Set initially by the allowHalfOpen constructor option, which defaults to true.

                                                                                      This can be changed manually to change the half-open behavior of an existing Duplex stream instance, but must be changed before the 'end' event is emitted.

                                                                                      v0.9.4

                                                                                      -
                                                                                      closed: boolean

                                                                                      Is true after 'close' has been emitted.

                                                                                      +
                                                                                      closed: boolean

                                                                                      Is true after 'close' has been emitted.

                                                                                      v18.0.0

                                                                                      destroyed: boolean

                                                                                      Is true after readable.destroy() has been called.

                                                                                      v8.0.0

                                                                                      @@ -137,33 +137,33 @@
                                                                                      writable: boolean

                                                                                      Is true if it is safe to call writable.write(), which means the stream has not been destroyed, errored, or ended.

                                                                                      v11.4.0

                                                                                      -
                                                                                      writableAborted: boolean

                                                                                      Returns whether the stream was destroyed or errored before emitting 'finish'.

                                                                                      +
                                                                                      writableAborted: boolean

                                                                                      Returns whether the stream was destroyed or errored before emitting 'finish'.

                                                                                      v18.0.0, v16.17.0

                                                                                      -
                                                                                      writableCorked: number

                                                                                      Number of times writable.uncork() needs to be +

                                                                                      writableCorked: number

                                                                                      Number of times writable.uncork() needs to be called in order to fully uncork the stream.

                                                                                      v13.2.0, v12.16.0

                                                                                      -
                                                                                      writableEnded: boolean

                                                                                      Is true after writable.end() has been called. This property +

                                                                                      writableEnded: boolean

                                                                                      Is true after writable.end() has been called. This property does not indicate whether the data has been flushed, for this use writable.writableFinished instead.

                                                                                      v12.9.0

                                                                                      -
                                                                                      writableFinished: boolean

                                                                                      Is set to true immediately before the 'finish' event is emitted.

                                                                                      +
                                                                                      writableFinished: boolean

                                                                                      Is set to true immediately before the 'finish' event is emitted.

                                                                                      v12.6.0

                                                                                      -
                                                                                      writableHighWaterMark: number

                                                                                      Return the value of highWaterMark passed when creating this Writable.

                                                                                      +
                                                                                      writableHighWaterMark: number

                                                                                      Return the value of highWaterMark passed when creating this Writable.

                                                                                      v9.3.0

                                                                                      -
                                                                                      writableLength: number

                                                                                      This property contains the number of bytes (or objects) in the queue +

                                                                                      writableLength: number

                                                                                      This property contains the number of bytes (or objects) in the queue ready to be written. The value provides introspection data regarding the status of the highWaterMark.

                                                                                      v9.4.0

                                                                                      -
                                                                                      writableNeedDrain: boolean

                                                                                      Is true if the stream's buffer has been full and stream will emit 'drain'.

                                                                                      +
                                                                                      writableNeedDrain: boolean

                                                                                      Is true if the stream's buffer has been full and stream will emit 'drain'.

                                                                                      v15.2.0, v14.17.0

                                                                                      -
                                                                                      writableObjectMode: boolean

                                                                                      Getter for the property objectMode of a given Writable stream.

                                                                                      +
                                                                                      writableObjectMode: boolean

                                                                                      Getter for the property objectMode of a given Writable stream.

                                                                                      v12.3.0

                                                                                      -
                                                                                      captureRejections: boolean

                                                                                      Value: boolean

                                                                                      +
                                                                                      captureRejections: boolean

                                                                                      Value: boolean

                                                                                      Change the default captureRejections option on all new EventEmitter objects.

                                                                                      v13.4.0, v12.16.0

                                                                                      -
                                                                                      captureRejectionSymbol: typeof captureRejectionSymbol

                                                                                      Value: Symbol.for('nodejs.rejection')

                                                                                      +
                                                                                      captureRejectionSymbol: typeof captureRejectionSymbol

                                                                                      Value: Symbol.for('nodejs.rejection')

                                                                                      See how to write a custom rejection handler.

                                                                                      v13.4.0, v12.16.0

                                                                                      -
                                                                                      defaultMaxListeners: number

                                                                                      By default, a maximum of 10 listeners can be registered for any single +

                                                                                      defaultMaxListeners: number

                                                                                      By default, a maximum of 10 listeners can be registered for any single event. This limit can be changed for individual EventEmitter instances using the emitter.setMaxListeners(n) method. To change the default for allEventEmitter instances, the events.defaultMaxListeners property @@ -188,13 +188,16 @@ listeners, respectively. Its name property is set to 'MaxListenersExceededWarning'.

                                                                                      v0.11.2

                                                                                      -
                                                                                      errorMonitor: typeof errorMonitor

                                                                                      This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

                                                                                      +
                                                                                      errorMonitor: typeof errorMonitor

                                                                                      This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

                                                                                      Installing a listener using this symbol does not change the behavior once an 'error' event is emitted. Therefore, the process will still crash if no regular 'error' listener is installed.

                                                                                      v13.6.0, v12.17.0

                                                                                      -

                                                                                      Methods

                                                                                      Optional_construct

                                                                                      • _construct(callback: (error?: Error) => void): void

                                                                                        Parameters

                                                                                        • callback: (error?: Error) => void

                                                                                        Returns void

                                                                                      _destroy

                                                                                      • _destroy(error: Error, callback: (error?: Error) => void): void

                                                                                        Parameters

                                                                                        • error: Error
                                                                                        • callback: (error?: Error) => void

                                                                                        Returns void

                                                                                      _final

                                                                                      • _final(callback: (error?: Error) => void): void

                                                                                        Parameters

                                                                                        • callback: (error?: Error) => void

                                                                                        Returns void

                                                                                      _flush

                                                                                      _read

                                                                                      • _read(size: number): void

                                                                                        Parameters

                                                                                        • size: number

                                                                                        Returns void

                                                                                      _transform

                                                                                      _write

                                                                                      • _write(
                                                                                            chunk: any,
                                                                                            encoding: BufferEncoding,
                                                                                            callback: (error?: Error) => void,
                                                                                        ): void

                                                                                        Parameters

                                                                                        Returns void

                                                                                      Optional_writev

                                                                                      • _writev(
                                                                                            chunks: { chunk: any; encoding: BufferEncoding }[],
                                                                                            callback: (error?: Error) => void,
                                                                                        ): void

                                                                                        Parameters

                                                                                        • chunks: { chunk: any; encoding: BufferEncoding }[]
                                                                                        • callback: (error?: Error) => void

                                                                                        Returns void

                                                                                      • Calls readable.destroy() with an AbortError and returns a promise that fulfills when the stream is finished.

                                                                                        +

                                                                                      Methods

                                                                                      Optional_construct

                                                                                      • _construct?(callback: (error?: Error) => void): void

                                                                                        Parameters

                                                                                        • callback: (error?: Error) => void

                                                                                        Returns void

                                                                                      _destroy

                                                                                      • _destroy(error: Error, callback: (error?: Error) => void): void

                                                                                        Parameters

                                                                                        • error: Error
                                                                                        • callback: (error?: Error) => void

                                                                                        Returns void

                                                                                      _final

                                                                                      • _final(callback: (error?: Error) => void): void

                                                                                        Parameters

                                                                                        • callback: (error?: Error) => void

                                                                                        Returns void

                                                                                      _flush

                                                                                      _read

                                                                                      • _read(size: number): void

                                                                                        Parameters

                                                                                        • size: number

                                                                                        Returns void

                                                                                      _transform

                                                                                      _write

                                                                                      • _write(
                                                                                            chunk: any,
                                                                                            encoding: BufferEncoding,
                                                                                            callback: (error?: Error) => void,
                                                                                        ): void

                                                                                        Parameters

                                                                                        Returns void

                                                                                      Optional_writev

                                                                                      • _writev?(
                                                                                            chunks: { chunk: any; encoding: BufferEncoding }[],
                                                                                            callback: (error?: Error) => void,
                                                                                        ): void

                                                                                        Parameters

                                                                                        • chunks: { chunk: any; encoding: BufferEncoding }[]
                                                                                        • callback: (error?: Error) => void

                                                                                        Returns void

                                                                                      • Calls readable.destroy() with an AbortError and returns +a promise that fulfills when the stream is finished.

                                                                                        Returns Promise<void>

                                                                                        v20.4.0

                                                                                        -

                                                                                      • Returns AsyncIterator<any>

                                                                                      • Type Parameters

                                                                                        • K

                                                                                        Parameters

                                                                                        • error: Error
                                                                                        • event: string | symbol
                                                                                        • ...args: AnyRest

                                                                                        Returns void

                                                                                      • Event emitter +

                                                                                      • Returns AsyncIterator<any>

                                                                                        AsyncIterator to fully consume the stream.

                                                                                        +

                                                                                        v10.0.0

                                                                                        +

                                                                                      • Type Parameters

                                                                                        • K

                                                                                        Parameters

                                                                                        • error: Error
                                                                                        • event: string | symbol
                                                                                        • ...args: AnyRest

                                                                                        Returns void

                                                                                      • Event emitter The defined events on documents including:

                                                                                        1. close
                                                                                          2. @@ -209,7 +212,7 @@
                                                                                        2. resume
                                                                                        3. unpipe
                                                                                        -

                                                                                        Parameters

                                                                                        • event: "close"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Event emitter +

                                                                                        Parameters

                                                                                        • event: "close"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Event emitter The defined events on documents including:

                                                                                        1. close
                                                                                          2. @@ -224,7 +227,7 @@
                                                                                        2. resume
                                                                                        3. unpipe
                                                                                        -

                                                                                        Parameters

                                                                                        • event: "data"
                                                                                        • listener: (chunk: any) => void

                                                                                        Returns this

                                                                                      • Event emitter +

                                                                                        Parameters

                                                                                        • event: "data"
                                                                                        • listener: (chunk: any) => void

                                                                                        Returns this

                                                                                      • Event emitter The defined events on documents including:

                                                                                        1. close
                                                                                          2. @@ -239,7 +242,7 @@
                                                                                        2. resume
                                                                                        3. unpipe
                                                                                        -

                                                                                        Parameters

                                                                                        • event: "drain"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Event emitter +

                                                                                        Parameters

                                                                                        • event: "drain"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Event emitter The defined events on documents including:

                                                                                        1. close
                                                                                          2. @@ -254,7 +257,7 @@
                                                                                        2. resume
                                                                                        3. unpipe
                                                                                        -

                                                                                        Parameters

                                                                                        • event: "end"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Event emitter +

                                                                                        Parameters

                                                                                        • event: "end"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Event emitter The defined events on documents including:

                                                                                        1. close
                                                                                          2. @@ -269,7 +272,7 @@
                                                                                        2. resume
                                                                                        3. unpipe
                                                                                        -

                                                                                        Parameters

                                                                                        • event: "error"
                                                                                        • listener: (err: Error) => void

                                                                                        Returns this

                                                                                      • Event emitter +

                                                                                        Parameters

                                                                                        • event: "error"
                                                                                        • listener: (err: Error) => void

                                                                                        Returns this

                                                                                      • Event emitter The defined events on documents including:

                                                                                        1. close
                                                                                          2. @@ -284,7 +287,7 @@
                                                                                        2. resume
                                                                                        3. unpipe
                                                                                        -

                                                                                        Parameters

                                                                                        • event: "finish"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Event emitter +

                                                                                        Parameters

                                                                                        • event: "finish"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Event emitter The defined events on documents including:

                                                                                        1. close
                                                                                          2. @@ -299,7 +302,7 @@
                                                                                        2. resume
                                                                                        3. unpipe
                                                                                        -

                                                                                        Parameters

                                                                                        • event: "pause"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Event emitter +

                                                                                        Parameters

                                                                                        • event: "pause"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Event emitter The defined events on documents including:

                                                                                        1. close
                                                                                          2. @@ -314,7 +317,7 @@
                                                                                        2. resume
                                                                                        3. unpipe
                                                                                        -

                                                                                        Parameters

                                                                                        • event: "pipe"
                                                                                        • listener: (src: Readable) => void

                                                                                        Returns this

                                                                                      • Event emitter +

                                                                                        Parameters

                                                                                        • event: "pipe"
                                                                                        • listener: (src: Readable) => void

                                                                                        Returns this

                                                                                      • Event emitter The defined events on documents including:

                                                                                        1. close
                                                                                          2. @@ -329,7 +332,7 @@
                                                                                        2. resume
                                                                                        3. unpipe
                                                                                        -

                                                                                        Parameters

                                                                                        • event: "readable"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Event emitter +

                                                                                        Parameters

                                                                                        • event: "readable"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Event emitter The defined events on documents including:

                                                                                        1. close
                                                                                          2. @@ -344,7 +347,7 @@
                                                                                        2. resume
                                                                                        3. unpipe
                                                                                        -

                                                                                        Parameters

                                                                                        • event: "resume"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Event emitter +

                                                                                        Parameters

                                                                                        • event: "resume"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Event emitter The defined events on documents including:

                                                                                        1. close
                                                                                          2. @@ -359,7 +362,7 @@
                                                                                        2. resume
                                                                                        3. unpipe
                                                                                        -

                                                                                        Parameters

                                                                                        • event: "unpipe"
                                                                                        • listener: (src: Readable) => void

                                                                                        Returns this

                                                                                      • Event emitter +

                                                                                        Parameters

                                                                                        • event: "unpipe"
                                                                                        • listener: (src: Readable) => void

                                                                                        Returns this

                                                                                      • Event emitter The defined events on documents including:

                                                                                        1. close
                                                                                          2. @@ -374,11 +377,11 @@
                                                                                        2. resume
                                                                                        3. unpipe
                                                                                        -

                                                                                        Parameters

                                                                                        • event: string | symbol
                                                                                        • listener: (...args: any[]) => void

                                                                                        Returns this

                                                                                      • This method returns a new stream with chunks of the underlying stream paired with a counter +

                                                                                        Parameters

                                                                                        • event: string | symbol
                                                                                        • listener: (...args: any[]) => void

                                                                                        Returns this

                                                                                      • This method returns a new stream with chunks of the underlying stream paired with a counter in the form [index, chunk]. The first index value is 0 and it increases by 1 for each chunk produced.

                                                                                        Parameters

                                                                                        Returns Readable

                                                                                        a stream of indexed pairs.

                                                                                        -

                                                                                        v17.5.0

                                                                                        -

                                                                                      • The writable.cork() method forces all written data to be buffered in memory. +

                                                                                        v17.5.0

                                                                                        +

                                                                                      • The writable.cork() method forces all written data to be buffered in memory. The buffered data will be flushed when either the uncork or end methods are called.

                                                                                        The primary intent of writable.cork() is to accommodate a situation in which several small chunks are written to the stream in rapid succession. Instead of @@ -387,26 +390,26 @@ situation where data is being buffered while waiting for the first small chunk to be processed. However, use of writable.cork() without implementing writable._writev() may have an adverse effect on throughput.

                                                                                        See also: writable.uncork(), writable._writev().

                                                                                        -

                                                                                        Returns void

                                                                                        v0.11.2

                                                                                        -

                                                                                      • Destroy the stream. Optionally emit an 'error' event, and emit a 'close' event (unless emitClose is set to false). After this call, the readable +

                                                                                        Returns void

                                                                                        v0.11.2

                                                                                        +

                                                                                      • Destroy the stream. Optionally emit an 'error' event, and emit a 'close' event (unless emitClose is set to false). After this call, the readable stream will release any internal resources and subsequent calls to push() will be ignored.

                                                                                        Once destroy() has been called any further calls will be a no-op and no further errors except from _destroy() may be emitted as 'error'.

                                                                                        Implementors should not override this method, but instead implement readable._destroy().

                                                                                        Parameters

                                                                                        • Optionalerror: Error

                                                                                          Error which will be passed as payload in 'error' event

                                                                                          -

                                                                                        Returns this

                                                                                        v8.0.0

                                                                                        -

                                                                                      • This method returns a new stream with the first limit chunks dropped from the start.

                                                                                        +

                                                                                      Returns this

                                                                                      v8.0.0

                                                                                      +

                                                                                      • This method returns a new stream with the first limit chunks dropped from the start.

                                                                                        Parameters

                                                                                        • limit: number

                                                                                          the number of chunks to drop from the readable.

                                                                                          -
                                                                                        • Optionaloptions: Pick<Stream.ArrayOptions, "signal">

                                                                                        Returns Readable

                                                                                        a stream with limit chunks dropped from the start.

                                                                                        -

                                                                                        v17.5.0

                                                                                        +
                                                                                      • Optionaloptions: Pick<Stream.ArrayOptions, "signal">

                                                                                      Returns Readable

                                                                                      a stream with limit chunks dropped from the start.

                                                                                      +

                                                                                      v17.5.0

                                                                                      • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

                                                                                        Returns true if the event had listeners, false otherwise.

                                                                                        import { EventEmitter } from 'node:events';
                                                                                        const myEmitter = new EventEmitter();

                                                                                        // First listener
                                                                                        myEmitter.on('event', function firstListener() {
                                                                                          console.log('Helloooo! first listener');
                                                                                        });
                                                                                        // Second listener
                                                                                        myEmitter.on('event', function secondListener(arg1, arg2) {
                                                                                          console.log(`event with parameters ${arg1}, ${arg2} in second listener`);
                                                                                        });
                                                                                        // Third listener
                                                                                        myEmitter.on('event', function thirdListener(...args) {
                                                                                          const parameters = args.join(', ');
                                                                                          console.log(`event with parameters ${parameters} in third listener`);
                                                                                        });

                                                                                        console.log(myEmitter.listeners('event'));

                                                                                        myEmitter.emit('event', 1, 2, 3, 4, 5);

                                                                                        // Prints:
                                                                                        // [
                                                                                        //   [Function: firstListener],
                                                                                        //   [Function: secondListener],
                                                                                        //   [Function: thirdListener]
                                                                                        // ]
                                                                                        // Helloooo! first listener
                                                                                        // event with parameters 1, 2 in second listener
                                                                                        // event with parameters 1, 2, 3, 4, 5 in third listener
                                                                                        -

                                                                                        Parameters

                                                                                        • event: "close"

                                                                                        Returns boolean

                                                                                        v0.1.26

                                                                                        -

                                                                                      • Parameters

                                                                                        • event: "data"
                                                                                        • chunk: any

                                                                                        Returns boolean

                                                                                      • Parameters

                                                                                        • event: "drain"

                                                                                        Returns boolean

                                                                                      • Parameters

                                                                                        • event: "end"

                                                                                        Returns boolean

                                                                                      • Parameters

                                                                                        • event: "error"
                                                                                        • err: Error

                                                                                        Returns boolean

                                                                                      • Parameters

                                                                                        • event: "finish"

                                                                                        Returns boolean

                                                                                      • Parameters

                                                                                        • event: "pause"

                                                                                        Returns boolean

                                                                                      • Parameters

                                                                                        Returns boolean

                                                                                      • Parameters

                                                                                        • event: "readable"

                                                                                        Returns boolean

                                                                                      • Parameters

                                                                                        • event: "resume"

                                                                                        Returns boolean

                                                                                      • Parameters

                                                                                        Returns boolean

                                                                                      • Parameters

                                                                                        • event: string | symbol
                                                                                        • ...args: any[]

                                                                                        Returns boolean

                                                                                      • Calling the writable.end() method signals that no more data will be written +

                                                                                        Parameters

                                                                                        • event: "close"

                                                                                        Returns boolean

                                                                                        v0.1.26

                                                                                        +

                                                                                      • Parameters

                                                                                        • event: "data"
                                                                                        • chunk: any

                                                                                        Returns boolean

                                                                                      • Parameters

                                                                                        • event: "drain"

                                                                                        Returns boolean

                                                                                      • Parameters

                                                                                        • event: "end"

                                                                                        Returns boolean

                                                                                      • Parameters

                                                                                        • event: "error"
                                                                                        • err: Error

                                                                                        Returns boolean

                                                                                      • Parameters

                                                                                        • event: "finish"

                                                                                        Returns boolean

                                                                                      • Parameters

                                                                                        • event: "pause"

                                                                                        Returns boolean

                                                                                      • Parameters

                                                                                        Returns boolean

                                                                                      • Parameters

                                                                                        • event: "readable"

                                                                                        Returns boolean

                                                                                      • Parameters

                                                                                        • event: "resume"

                                                                                        Returns boolean

                                                                                      • Parameters

                                                                                        Returns boolean

                                                                                      • Parameters

                                                                                        • event: string | symbol
                                                                                        • ...args: any[]

                                                                                        Returns boolean

                                                                                      • Calling the writable.end() method signals that no more data will be written to the Writable. The optional chunk and encoding arguments allow one final additional chunk of data to be written immediately before closing the stream.

                                                                                        @@ -414,8 +417,8 @@ 
                                                                                        // Write 'hello, ' and then end with 'world!'.
                                                                                        import fs from 'node:fs';
                                                                                        const file = fs.createWriteStream('example.txt');
                                                                                        file.write('hello, ');
                                                                                        file.end('world!');
                                                                                        // Writing more now is not allowed!
                                                                                        -

                                                                                        Parameters

                                                                                        • Optionalcb: () => void

                                                                                        Returns this

                                                                                        v0.9.4

                                                                                        -

                                                                                      • Calling the writable.end() method signals that no more data will be written +

                                                                                        Parameters

                                                                                        • Optionalcb: () => void

                                                                                        Returns this

                                                                                        v0.9.4

                                                                                        +

                                                                                      • Calling the writable.end() method signals that no more data will be written to the Writable. The optional chunk and encoding arguments allow one final additional chunk of data to be written immediately before closing the stream.

                                                                                        @@ -425,8 +428,8 @@

                                                                                        Parameters

                                                                                        • chunk: any

                                                                                          Optional data to write. For streams not operating in object mode, chunk must be a {string}, {Buffer}, {TypedArray} or {DataView}. For object mode streams, chunk may be any JavaScript value other than null.

                                                                                          -
                                                                                        • Optionalcb: () => void

                                                                                        Returns this

                                                                                        v0.9.4

                                                                                        -

                                                                                      • Calling the writable.end() method signals that no more data will be written +

                                                                                      • Optionalcb: () => void

                                                                                      Returns this

                                                                                      v0.9.4

                                                                                      +

                                                                                    • Calling the writable.end() method signals that no more data will be written to the Writable. The optional chunk and encoding arguments allow one final additional chunk of data to be written immediately before closing the stream.

                                                                                      @@ -436,51 +439,51 @@

                                                                                      Parameters

                                                                                      • chunk: any

                                                                                        Optional data to write. For streams not operating in object mode, chunk must be a {string}, {Buffer}, {TypedArray} or {DataView}. For object mode streams, chunk may be any JavaScript value other than null.

                                                                                        -
                                                                                      • encoding: BufferEncoding

                                                                                        The encoding if chunk is a string

                                                                                        -
                                                                                      • Optionalcb: () => void

                                                                                      Returns this

                                                                                      v0.9.4

                                                                                      -

                                                                                      • Returns an array listing the events for which the emitter has registered +

                                                                                      • encoding: BufferEncoding

                                                                                        The encoding if chunk is a string

                                                                                        +
                                                                                      • Optionalcb: () => void

                                                                                      Returns this

                                                                                      v0.9.4

                                                                                      +

                                                                                      • Returns an array listing the events for which the emitter has registered listeners. The values in the array are strings or Symbols.

                                                                                        import { EventEmitter } from 'node:events';

                                                                                        const myEE = new EventEmitter();
                                                                                        myEE.on('foo', () => {});
                                                                                        myEE.on('bar', () => {});

                                                                                        const sym = Symbol('symbol');
                                                                                        myEE.on(sym, () => {});

                                                                                        console.log(myEE.eventNames());
                                                                                        // Prints: [ 'foo', 'bar', Symbol(symbol) ]
                                                                                        -

                                                                                        Returns (string | symbol)[]

                                                                                        v6.0.0

                                                                                        -

                                                                                      • This method is similar to Array.prototype.every and calls fn on each chunk in the stream +

                                                                                        Returns (string | symbol)[]

                                                                                        v6.0.0

                                                                                        +

                                                                                      • This method is similar to Array.prototype.every and calls fn on each chunk in the stream to check if all awaited return values are truthy value for fn. Once an fn call on a chunk awaited return value is falsy, the stream is destroyed and the promise is fulfilled with false. If all of the fn calls on the chunks return a truthy value, the promise is fulfilled with true.

                                                                                        Parameters

                                                                                        • fn: (
                                                                                              data: any,
                                                                                              options?: Pick<Stream.ArrayOptions, "signal">,
                                                                                          ) => boolean | Promise<boolean>

                                                                                          a function to call on each chunk of the stream. Async or not.

                                                                                          -
                                                                                        • Optionaloptions: Stream.ArrayOptions

                                                                                        Returns Promise<boolean>

                                                                                        a promise evaluating to true if fn returned a truthy value for every one of the chunks.

                                                                                        -

                                                                                        v17.5.0

                                                                                        -

                                                                                      • This method allows filtering the stream. For each chunk in the stream the fn function will be called +

                                                                                      • Optionaloptions: Stream.ArrayOptions

                                                                                      Returns Promise<boolean>

                                                                                      a promise evaluating to true if fn returned a truthy value for every one of the chunks.

                                                                                      +

                                                                                      v17.5.0

                                                                                      +

                                                                                      • This method allows filtering the stream. For each chunk in the stream the fn function will be called and if it returns a truthy value, the chunk will be passed to the result stream. If the fn function returns a promise - that promise will be awaited.

                                                                                        Parameters

                                                                                        • fn: (
                                                                                              data: any,
                                                                                              options?: Pick<Stream.ArrayOptions, "signal">,
                                                                                          ) => boolean | Promise<boolean>

                                                                                          a function to filter chunks from the stream. Async or not.

                                                                                          -
                                                                                        • Optionaloptions: Stream.ArrayOptions

                                                                                        Returns Readable

                                                                                        a stream filtered with the predicate fn.

                                                                                        -

                                                                                        v17.4.0, v16.14.0

                                                                                        -

                                                                                      • This method is similar to Array.prototype.find and calls fn on each chunk in the stream +

                                                                                      • Optionaloptions: Stream.ArrayOptions

                                                                                      Returns Readable

                                                                                      a stream filtered with the predicate fn.

                                                                                      +

                                                                                      v17.4.0, v16.14.0

                                                                                      +

                                                                                      • This method is similar to Array.prototype.find and calls fn on each chunk in the stream to find a chunk with a truthy value for fn. Once an fn call's awaited return value is truthy, the stream is destroyed and the promise is fulfilled with value for which fn returned a truthy value. If all of the fn calls on the chunks return a falsy value, the promise is fulfilled with undefined.

                                                                                        Type Parameters

                                                                                        • T

                                                                                        Parameters

                                                                                        Returns Promise<T>

                                                                                        a promise evaluating to the first chunk for which fn evaluated with a truthy value, +

                                                                                      • Optionaloptions: Stream.ArrayOptions

                                                                                      Returns Promise<T>

                                                                                      a promise evaluating to the first chunk for which fn evaluated with a truthy value, or undefined if no element was found.

                                                                                      -

                                                                                      v17.5.0

                                                                                      -

                                                                                    • This method is similar to Array.prototype.find and calls fn on each chunk in the stream +

                                                                                      v17.5.0

                                                                                      +

                                                                                    • This method is similar to Array.prototype.find and calls fn on each chunk in the stream to find a chunk with a truthy value for fn. Once an fn call's awaited return value is truthy, the stream is destroyed and the promise is fulfilled with value for which fn returned a truthy value. If all of the fn calls on the chunks return a falsy value, the promise is fulfilled with undefined.

                                                                                      Parameters

                                                                                      • fn: (
                                                                                            data: any,
                                                                                            options?: Pick<Stream.ArrayOptions, "signal">,
                                                                                        ) => boolean | Promise<boolean>

                                                                                        a function to call on each chunk of the stream. Async or not.

                                                                                        -
                                                                                      • Optionaloptions: Stream.ArrayOptions

                                                                                      Returns Promise<any>

                                                                                      a promise evaluating to the first chunk for which fn evaluated with a truthy value, +

                                                                                    • Optionaloptions: Stream.ArrayOptions

                                                                                      • Returns Promise<any>

                                                                                      a promise evaluating to the first chunk for which fn evaluated with a truthy value, or undefined if no element was found.

                                                                                      -

                                                                                      v17.5.0

                                                                                      -

                                                                                      • This method returns a new stream by applying the given callback to each chunk of the stream +

                                                                                        v17.5.0

                                                                                        +

                                                                                      • This method returns a new stream by applying the given callback to each chunk of the stream and then flattening the result.

                                                                                        It is possible to return a stream or another iterable or async iterable from fn and the result streams will be merged (flattened) into the returned stream.

                                                                                        Parameters

                                                                                        • fn: (data: any, options?: Pick<Stream.ArrayOptions, "signal">) => any

                                                                                          a function to map over every chunk in the stream. May be async. May be a stream or generator.

                                                                                          -
                                                                                        • Optionaloptions: Stream.ArrayOptions

                                                                                        Returns Readable

                                                                                        a stream flat-mapped with the function fn.

                                                                                        -

                                                                                        v17.5.0

                                                                                        -

                                                                                      • This method allows iterating a stream. For each chunk in the stream the fn function will be called. +

                                                                                      • Optionaloptions: Stream.ArrayOptions

                                                                                      Returns Readable

                                                                                      a stream flat-mapped with the function fn.

                                                                                      +

                                                                                      v17.5.0

                                                                                      +

                                                                                      • This method allows iterating a stream. For each chunk in the stream the fn function will be called. If the fn function returns a promise - that promise will be awaited.

                                                                                        This method is different from for await...of loops in that it can optionally process chunks concurrently. In addition, a forEach iteration can only be stopped by having passed a signal option @@ -489,44 +492,44 @@

                                                                                        This method is different from listening to the 'data' event in that it uses the readable event in the underlying machinary and can limit the number of concurrent fn calls.

                                                                                        Parameters

                                                                                        • fn: (
                                                                                              data: any,
                                                                                              options?: Pick<Stream.ArrayOptions, "signal">,
                                                                                          ) => void | Promise<void>

                                                                                          a function to call on each chunk of the stream. Async or not.

                                                                                          -
                                                                                        • Optionaloptions: Stream.ArrayOptions

                                                                                        Returns Promise<void>

                                                                                        a promise for when the stream has finished.

                                                                                        -

                                                                                        v17.5.0

                                                                                        -

                                                                                      • Returns the current max listener value for the EventEmitter which is either +

                                                                                      • Optionaloptions: Stream.ArrayOptions

                                                                                      Returns Promise<void>

                                                                                      a promise for when the stream has finished.

                                                                                      +

                                                                                      v17.5.0

                                                                                      +

                                                                                      • Returns the current max listener value for the EventEmitter which is either set by emitter.setMaxListeners(n) or defaults to EventEmitter.defaultMaxListeners.

                                                                                        -

                                                                                        Returns number

                                                                                        v1.0.0

                                                                                        -

                                                                                      • The readable.isPaused() method returns the current operating state of the Readable. +

                                                                                        Returns number

                                                                                        v1.0.0

                                                                                        +

                                                                                      • The readable.isPaused() method returns the current operating state of the Readable. This is used primarily by the mechanism that underlies the readable.pipe() method. In most typical cases, there will be no reason to use this method directly.

                                                                                        const readable = new stream.Readable();

                                                                                        readable.isPaused(); // === false
                                                                                        readable.pause();
                                                                                        readable.isPaused(); // === true
                                                                                        readable.resume();
                                                                                        readable.isPaused(); // === false
                                                                                        -

                                                                                        Returns boolean

                                                                                        v0.11.14

                                                                                        +

                                                                                        Returns boolean

                                                                                        v0.11.14

                                                                                      • The iterator created by this method gives users the option to cancel the destruction of the stream if the for await...of loop is exited by return, break, or throw, or if the iterator should destroy the stream if the stream emitted an error during iteration.

                                                                                        Parameters

                                                                                        • Optionaloptions: { destroyOnReturn?: boolean }
                                                                                          • OptionaldestroyOnReturn?: boolean

                                                                                            When set to false, calling return on the async iterator, or exiting a for await...of iteration using a break, return, or throw will not destroy the stream. Default: true.

                                                                                            -

                                                                                        Returns AsyncIterator<any>

                                                                                        v16.3.0

                                                                                        -

                                                                                      • Returns the number of listeners listening for the event named eventName. +

                                                                                      Returns AsyncIterator<any>

                                                                                      v16.3.0

                                                                                      +

                                                                                      • Returns the number of listeners listening for the event named eventName. If listener is provided, it will return how many times the listener is found in the list of the listeners of the event.

                                                                                        Type Parameters

                                                                                        • K

                                                                                        Parameters

                                                                                        • eventName: string | symbol

                                                                                          The name of the event being listened for

                                                                                          -
                                                                                        • Optionallistener: Function

                                                                                          The event handler function

                                                                                          -

                                                                                        Returns number

                                                                                        v3.2.0

                                                                                        -

                                                                                      • Returns a copy of the array of listeners for the event named eventName.

                                                                                        +
                                                                                      • Optionallistener: Function

                                                                                        The event handler function

                                                                                        +

                                                                                      Returns number

                                                                                      v3.2.0

                                                                                      +

                                                                                      • Returns a copy of the array of listeners for the event named eventName.

                                                                                        server.on('connection', (stream) => {
                                                                                          console.log('someone connected!');
                                                                                        });
                                                                                        console.log(util.inspect(server.listeners('connection')));
                                                                                        // Prints: [ [Function] ]
                                                                                        -

                                                                                        Type Parameters

                                                                                        • K

                                                                                        Parameters

                                                                                        • eventName: string | symbol

                                                                                        Returns Function[]

                                                                                        v0.1.26

                                                                                        -

                                                                                      • This method allows mapping over the stream. The fn function will be called for every chunk in the stream. +

                                                                                        Type Parameters

                                                                                        • K

                                                                                        Parameters

                                                                                        • eventName: string | symbol

                                                                                        Returns Function[]

                                                                                        v0.1.26

                                                                                        +

                                                                                      • This method allows mapping over the stream. The fn function will be called for every chunk in the stream. If the fn function returns a promise - that promise will be awaited before being passed to the result stream.

                                                                                        Parameters

                                                                                        Returns Readable

                                                                                        a stream mapped with the function fn.

                                                                                        -

                                                                                        v17.4.0, v16.14.0

                                                                                        -

                                                                                      • Alias for emitter.removeListener().

                                                                                        -

                                                                                        Type Parameters

                                                                                        • K

                                                                                        Parameters

                                                                                        • eventName: string | symbol
                                                                                        • listener: (...args: any[]) => void

                                                                                        Returns this

                                                                                        v10.0.0

                                                                                        -

                                                                                      • Adds the listener function to the end of the listeners array for the event +

                                                                                      • Optionaloptions: Stream.ArrayOptions

                                                                                      Returns Readable

                                                                                      a stream mapped with the function fn.

                                                                                      +

                                                                                      v17.4.0, v16.14.0

                                                                                      +

                                                                                      • Alias for emitter.removeListener().

                                                                                        +

                                                                                        Type Parameters

                                                                                        • K

                                                                                        Parameters

                                                                                        • eventName: string | symbol
                                                                                        • listener: (...args: any[]) => void

                                                                                        Returns this

                                                                                        v10.0.0

                                                                                        +

                                                                                      • Adds the listener function to the end of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.

                                                                                        @@ -540,8 +543,8 @@

                                                                                        Parameters

                                                                                        • event: "close"
                                                                                        • listener: () => void

                                                                                          The callback function

                                                                                          -

                                                                                        Returns this

                                                                                        v0.1.101

                                                                                        -

                                                                                      • Parameters

                                                                                        • event: "data"
                                                                                        • listener: (chunk: any) => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "drain"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "end"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "error"
                                                                                        • listener: (err: Error) => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "finish"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "pause"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "pipe"
                                                                                        • listener: (src: Readable) => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "readable"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "resume"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "unpipe"
                                                                                        • listener: (src: Readable) => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: string | symbol
                                                                                        • listener: (...args: any[]) => void

                                                                                        Returns this

                                                                                      • Adds a one-time listener function for the event named eventName. The +

                                                                                      Returns this

                                                                                      v0.1.101

                                                                                      +

                                                                                    • Parameters

                                                                                      • event: "data"
                                                                                      • listener: (chunk: any) => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "drain"
                                                                                      • listener: () => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "end"
                                                                                      • listener: () => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "error"
                                                                                      • listener: (err: Error) => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "finish"
                                                                                      • listener: () => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "pause"
                                                                                      • listener: () => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "pipe"
                                                                                      • listener: (src: Readable) => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "readable"
                                                                                      • listener: () => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "resume"
                                                                                      • listener: () => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "unpipe"
                                                                                      • listener: (src: Readable) => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: string | symbol
                                                                                      • listener: (...args: any[]) => void

                                                                                      Returns this

                                                                                      • Adds a one-time listener function for the event named eventName. The next time eventName is triggered, this listener is removed and then invoked.

                                                                                        server.once('connection', (stream) => {
                                                                                          console.log('Ah, we have our first user!');
                                                                                        });
                                                                                        @@ -553,16 +556,16 @@

                                                                                        Parameters

                                                                                        • event: "close"
                                                                                        • listener: () => void

                                                                                          The callback function

                                                                                          -

                                                                                        Returns this

                                                                                        v0.3.0

                                                                                        -

                                                                                      • Parameters

                                                                                        • event: "data"
                                                                                        • listener: (chunk: any) => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "drain"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "end"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "error"
                                                                                        • listener: (err: Error) => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "finish"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "pause"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "pipe"
                                                                                        • listener: (src: Readable) => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "readable"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "resume"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "unpipe"
                                                                                        • listener: (src: Readable) => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: string | symbol
                                                                                        • listener: (...args: any[]) => void

                                                                                        Returns this

                                                                                      • The readable.pause() method will cause a stream in flowing mode to stop +

                                                                                      Returns this

                                                                                      v0.3.0

                                                                                      +

                                                                                    • Parameters

                                                                                      • event: "data"
                                                                                      • listener: (chunk: any) => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "drain"
                                                                                      • listener: () => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "end"
                                                                                      • listener: () => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "error"
                                                                                      • listener: (err: Error) => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "finish"
                                                                                      • listener: () => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "pause"
                                                                                      • listener: () => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "pipe"
                                                                                      • listener: (src: Readable) => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "readable"
                                                                                      • listener: () => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "resume"
                                                                                      • listener: () => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "unpipe"
                                                                                      • listener: (src: Readable) => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: string | symbol
                                                                                      • listener: (...args: any[]) => void

                                                                                      Returns this

                                                                                      • The readable.pause() method will cause a stream in flowing mode to stop emitting 'data' events, switching out of flowing mode. Any data that becomes available will remain in the internal buffer.

                                                                                        const readable = getReadableStreamSomehow();
                                                                                        readable.on('data', (chunk) => {
                                                                                          console.log(`Received ${chunk.length} bytes of data.`);
                                                                                          readable.pause();
                                                                                          console.log('There will be no additional data for 1 second.');
                                                                                          setTimeout(() => {
                                                                                            console.log('Now data will start flowing again.');
                                                                                            readable.resume();
                                                                                          }, 1000);
                                                                                        });

                                                                                        The readable.pause() method has no effect if there is a 'readable' event listener.

                                                                                        -

                                                                                        Returns this

                                                                                        v0.9.4

                                                                                        -

                                                                                      • Type Parameters

                                                                                        Parameters

                                                                                        • destination: T
                                                                                        • Optionaloptions: { end?: boolean }

                                                                                        Returns T

                                                                                      • Adds the listener function to the beginning of the listeners array for the +

                                                                                        Returns this

                                                                                        v0.9.4

                                                                                        +

                                                                                      • Type Parameters

                                                                                        Parameters

                                                                                        • destination: T
                                                                                        • Optionaloptions: { end?: boolean }

                                                                                        Returns T

                                                                                      • Adds the listener function to the beginning of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.

                                                                                        @@ -571,22 +574,22 @@

                                                                                        Returns a reference to the EventEmitter, so that calls can be chained.

                                                                                        Parameters

                                                                                        • event: "close"
                                                                                        • listener: () => void

                                                                                          The callback function

                                                                                          -

                                                                                        Returns this

                                                                                        v6.0.0

                                                                                        -

                                                                                      • Parameters

                                                                                        • event: "data"
                                                                                        • listener: (chunk: any) => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "drain"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "end"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "error"
                                                                                        • listener: (err: Error) => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "finish"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "pause"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "pipe"
                                                                                        • listener: (src: Readable) => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "readable"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "resume"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "unpipe"
                                                                                        • listener: (src: Readable) => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: string | symbol
                                                                                        • listener: (...args: any[]) => void

                                                                                        Returns this

                                                                                      • Adds a one-timelistener function for the event named eventName to the beginning of the listeners array. The next time eventName is triggered, this +

                                                                                      Returns this

                                                                                      v6.0.0

                                                                                      +

                                                                                    • Parameters

                                                                                      • event: "data"
                                                                                      • listener: (chunk: any) => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "drain"
                                                                                      • listener: () => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "end"
                                                                                      • listener: () => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "error"
                                                                                      • listener: (err: Error) => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "finish"
                                                                                      • listener: () => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "pause"
                                                                                      • listener: () => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "pipe"
                                                                                      • listener: (src: Readable) => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "readable"
                                                                                      • listener: () => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "resume"
                                                                                      • listener: () => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "unpipe"
                                                                                      • listener: (src: Readable) => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: string | symbol
                                                                                      • listener: (...args: any[]) => void

                                                                                      Returns this

                                                                                      • Adds a one-timelistener function for the event named eventName to the beginning of the listeners array. The next time eventName is triggered, this listener is removed, and then invoked.

                                                                                        server.prependOnceListener('connection', (stream) => {
                                                                                          console.log('Ah, we have our first user!');
                                                                                        });

                                                                                        Returns a reference to the EventEmitter, so that calls can be chained.

                                                                                        Parameters

                                                                                        • event: "close"
                                                                                        • listener: () => void

                                                                                          The callback function

                                                                                          -

                                                                                        Returns this

                                                                                        v6.0.0

                                                                                        -

                                                                                      • Parameters

                                                                                        • event: "data"
                                                                                        • listener: (chunk: any) => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "drain"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "end"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "error"
                                                                                        • listener: (err: Error) => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "finish"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "pause"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "pipe"
                                                                                        • listener: (src: Readable) => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "readable"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "resume"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "unpipe"
                                                                                        • listener: (src: Readable) => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: string | symbol
                                                                                        • listener: (...args: any[]) => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        Returns boolean

                                                                                      • Returns a copy of the array of listeners for the event named eventName, +

                                                                                      Returns this

                                                                                      v6.0.0

                                                                                      +

                                                                                    • Parameters

                                                                                      • event: "data"
                                                                                      • listener: (chunk: any) => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "drain"
                                                                                      • listener: () => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "end"
                                                                                      • listener: () => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "error"
                                                                                      • listener: (err: Error) => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "finish"
                                                                                      • listener: () => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "pause"
                                                                                      • listener: () => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "pipe"
                                                                                      • listener: (src: Readable) => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "readable"
                                                                                      • listener: () => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "resume"
                                                                                      • listener: () => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: "unpipe"
                                                                                      • listener: (src: Readable) => void

                                                                                      Returns this

                                                                                    • Parameters

                                                                                      • event: string | symbol
                                                                                      • listener: (...args: any[]) => void

                                                                                      Returns this

                                                                                      • Parameters

                                                                                        Returns boolean

                                                                                      • Returns a copy of the array of listeners for the event named eventName, including any wrappers (such as those created by .once()).

                                                                                        import { EventEmitter } from 'node:events';
                                                                                        const emitter = new EventEmitter();
                                                                                        emitter.once('log', () => console.log('log once'));

                                                                                        // Returns a new Array with a function `onceWrapper` which has a property
                                                                                        // `listener` which contains the original listener bound above
                                                                                        const listeners = emitter.rawListeners('log');
                                                                                        const logFnWrapper = listeners[0];

                                                                                        // Logs "log once" to the console and does not unbind the `once` event
                                                                                        logFnWrapper.listener();

                                                                                        // Logs "log once" to the console and removes the listener
                                                                                        logFnWrapper();

                                                                                        emitter.on('log', () => console.log('log persistently'));
                                                                                        // Will return a new Array with a single function bound by `.on()` above
                                                                                        const newListeners = emitter.rawListeners('log');

                                                                                        // Logs "log persistently" twice
                                                                                        newListeners[0]();
                                                                                        emitter.emit('log');
                                                                                        -

                                                                                        Type Parameters

                                                                                        • K

                                                                                        Parameters

                                                                                        • eventName: string | symbol

                                                                                        Returns Function[]

                                                                                        v9.4.0

                                                                                        -

                                                                                      • The readable.read() method reads data out of the internal buffer and +

                                                                                        Type Parameters

                                                                                        • K

                                                                                        Parameters

                                                                                        • eventName: string | symbol

                                                                                        Returns Function[]

                                                                                        v9.4.0

                                                                                        +

                                                                                      • The readable.read() method reads data out of the internal buffer and returns it. If no data is available to be read, null is returned. By default, the data is returned as a Buffer object unless an encoding has been specified using the readable.setEncoding() method or the stream is operating @@ -623,7 +626,7 @@

                                                                                        Calling read after the 'end' event has been emitted will return null. No runtime error will be raised.

                                                                                        Parameters

                                                                                        • Optionalsize: number

                                                                                          Optional argument to specify how much data to read.

                                                                                          -

                                                                                        Returns any

                                                                                        v0.9.4

                                                                                        +

                                                                                      Returns any

                                                                                      v0.9.4

                                                                                      • This method calls fn on each chunk of the stream in order, passing it the result from the calculation on the previous element. It returns a promise for the final value of the reduction.

                                                                                        If no initial value is supplied the first chunk of the stream is used as the initial value. @@ -631,26 +634,26 @@

                                                                                        The reducer function iterates the stream element-by-element which means that there is no concurrency parameter or parallelism. To perform a reduce concurrently, you can extract the async function to readable.map method.

                                                                                        Type Parameters

                                                                                        • T = any

                                                                                        Parameters

                                                                                        • fn: (previous: any, data: any, options?: Pick<Stream.ArrayOptions, "signal">) => T

                                                                                          a reducer function to call over every chunk in the stream. Async or not.

                                                                                          -
                                                                                        • Optionalinitial: undefined

                                                                                          the initial value to use in the reduction.

                                                                                          -
                                                                                        • Optionaloptions: Pick<Stream.ArrayOptions, "signal">

                                                                                        Returns Promise<T>

                                                                                        a promise for the final value of the reduction.

                                                                                        -

                                                                                        v17.5.0

                                                                                        -

                                                                                      • This method calls fn on each chunk of the stream in order, passing it the result from the calculation +

                                                                                      • Optionalinitial: undefined

                                                                                        the initial value to use in the reduction.

                                                                                        +
                                                                                      • Optionaloptions: Pick<Stream.ArrayOptions, "signal">

                                                                                      Returns Promise<T>

                                                                                      a promise for the final value of the reduction.

                                                                                      +

                                                                                      v17.5.0

                                                                                      +

                                                                                    • This method calls fn on each chunk of the stream in order, passing it the result from the calculation on the previous element. It returns a promise for the final value of the reduction.

                                                                                      If no initial value is supplied the first chunk of the stream is used as the initial value. If the stream is empty, the promise is rejected with a TypeError with the ERR_INVALID_ARGS code property.

                                                                                      The reducer function iterates the stream element-by-element which means that there is no concurrency parameter or parallelism. To perform a reduce concurrently, you can extract the async function to readable.map method.

                                                                                      Type Parameters

                                                                                      • T = any

                                                                                      Parameters

                                                                                      • fn: (previous: T, data: any, options?: Pick<Stream.ArrayOptions, "signal">) => T

                                                                                        a reducer function to call over every chunk in the stream. Async or not.

                                                                                        -
                                                                                      • initial: T

                                                                                        the initial value to use in the reduction.

                                                                                        -
                                                                                      • Optionaloptions: Pick<Stream.ArrayOptions, "signal">

                                                                                      Returns Promise<T>

                                                                                      a promise for the final value of the reduction.

                                                                                      -

                                                                                      v17.5.0

                                                                                      -

                                                                                      • Removes all listeners, or those of the specified eventName.

                                                                                        +
                                                                                      • initial: T

                                                                                        the initial value to use in the reduction.

                                                                                        +
                                                                                      • Optionaloptions: Pick<Stream.ArrayOptions, "signal">

                                                                                      Returns Promise<T>

                                                                                      a promise for the final value of the reduction.

                                                                                      +

                                                                                      v17.5.0

                                                                                      +

                                                                                      • Removes all listeners, or those of the specified eventName.

                                                                                        It is bad practice to remove listeners added elsewhere in the code, particularly when the EventEmitter instance was created by some other component or module (e.g. sockets or file streams).

                                                                                        Returns a reference to the EventEmitter, so that calls can be chained.

                                                                                        -

                                                                                        Parameters

                                                                                        • OptionaleventName: string | symbol

                                                                                        Returns this

                                                                                        v0.1.26

                                                                                        -

                                                                                      • Removes the specified listener from the listener array for the event named eventName.

                                                                                        +

                                                                                        Parameters

                                                                                        • OptionaleventName: string | symbol

                                                                                        Returns this

                                                                                        v0.1.26

                                                                                        +

                                                                                      • Removes the specified listener from the listener array for the event named eventName.

                                                                                        const callback = (stream) => {
                                                                                          console.log('someone connected!');
                                                                                        };
                                                                                        server.on('connection', callback);
                                                                                        // ...
                                                                                        server.removeListener('connection', callback);
                                                                                        @@ -676,8 +679,8 @@

                                                                                        Returns a reference to the EventEmitter, so that calls can be chained.

                                                                                        -

                                                                                        Parameters

                                                                                        • event: "close"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                        v0.1.26

                                                                                        -

                                                                                      • Parameters

                                                                                        • event: "data"
                                                                                        • listener: (chunk: any) => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "drain"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "end"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "error"
                                                                                        • listener: (err: Error) => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "finish"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "pause"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "pipe"
                                                                                        • listener: (src: Readable) => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "readable"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "resume"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "unpipe"
                                                                                        • listener: (src: Readable) => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: string | symbol
                                                                                        • listener: (...args: any[]) => void

                                                                                        Returns this

                                                                                      • The readable.resume() method causes an explicitly paused Readable stream to +

                                                                                        Parameters

                                                                                        • event: "close"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                        v0.1.26

                                                                                        +

                                                                                      • Parameters

                                                                                        • event: "data"
                                                                                        • listener: (chunk: any) => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "drain"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "end"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "error"
                                                                                        • listener: (err: Error) => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "finish"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "pause"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "pipe"
                                                                                        • listener: (src: Readable) => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "readable"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "resume"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "unpipe"
                                                                                        • listener: (src: Readable) => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: string | symbol
                                                                                        • listener: (...args: any[]) => void

                                                                                        Returns this

                                                                                      • The readable.resume() method causes an explicitly paused Readable stream to resume emitting 'data' events, switching the stream into flowing mode.

                                                                                        The readable.resume() method can be used to fully consume the data from a stream without actually processing any of that data:

                                                                                        @@ -685,11 +688,11 @@

                                                                                        The readable.resume() method has no effect if there is a 'readable' event listener.

                                                                                        -

                                                                                        Returns this

                                                                                        v0.9.4

                                                                                        -

                                                                                      • The writable.setDefaultEncoding() method sets the default encoding for a Writable stream.

                                                                                        +

                                                                                        Returns this

                                                                                        v0.9.4

                                                                                        +

                                                                                      • The writable.setDefaultEncoding() method sets the default encoding for a Writable stream.

                                                                                        Parameters

                                                                                        Returns this

                                                                                        v0.11.15

                                                                                        -

                                                                                      • The readable.setEncoding() method sets the character encoding for +

                                                                                      Returns this

                                                                                      v0.11.15

                                                                                      +

                                                                                      • The readable.setEncoding() method sets the character encoding for data read from the Readable stream.

                                                                                        By default, no encoding is assigned and stream data will be returned as Buffer objects. Setting an encoding causes the stream data to be returned as strings of the specified encoding rather than as Buffer objects. For instance, calling readable.setEncoding('utf8') will cause the @@ -702,29 +705,29 @@

                                                                                        Parameters

                                                                                        Returns this

                                                                                        v0.9.4

                                                                                        -

                                                                                      • By default EventEmitters will print a warning if more than 10 listeners are +

                                                                                      Returns this

                                                                                      v0.9.4

                                                                                      +

                                                                                      • By default EventEmitters will print a warning if more than 10 listeners are added for a particular event. This is a useful default that helps finding memory leaks. The emitter.setMaxListeners() method allows the limit to be modified for this specific EventEmitter instance. The value can be set to Infinity (or 0) to indicate an unlimited number of listeners.

                                                                                        Returns a reference to the EventEmitter, so that calls can be chained.

                                                                                        -

                                                                                        Parameters

                                                                                        • n: number

                                                                                        Returns this

                                                                                        v0.3.5

                                                                                        -

                                                                                      • This method is similar to Array.prototype.some and calls fn on each chunk in the stream +

                                                                                        Parameters

                                                                                        • n: number

                                                                                        Returns this

                                                                                        v0.3.5

                                                                                        +

                                                                                      • This method is similar to Array.prototype.some and calls fn on each chunk in the stream until the awaited return value is true (or any truthy value). Once an fn call on a chunk awaited return value is truthy, the stream is destroyed and the promise is fulfilled with true. If none of the fn calls on the chunks return a truthy value, the promise is fulfilled with false.

                                                                                        Parameters

                                                                                        • fn: (
                                                                                              data: any,
                                                                                              options?: Pick<Stream.ArrayOptions, "signal">,
                                                                                          ) => boolean | Promise<boolean>

                                                                                          a function to call on each chunk of the stream. Async or not.

                                                                                          -
                                                                                        • Optionaloptions: Stream.ArrayOptions

                                                                                        Returns Promise<boolean>

                                                                                        a promise evaluating to true if fn returned a truthy value for at least one of the chunks.

                                                                                        -

                                                                                        v17.5.0

                                                                                        -

                                                                                      Returns Promise<boolean>

                                                                                      a promise evaluating to true if fn returned a truthy value for at least one of the chunks.

                                                                                      v17.5.0

                                                                                      +

                                                                                      • This method returns a new stream with the first limit chunks.

                                                                                        +

                                                                                        Parameters

                                                                                        • limit: number

                                                                                          the number of chunks to take from the readable.

                                                                                          +
                                                                                        • Optionaloptions: Pick<Stream.ArrayOptions, "signal">

                                                                                        Returns Readable

                                                                                        a stream with limit chunks taken.

                                                                                        +

                                                                                        v17.5.0

                                                                                      • This method allows easily obtaining the contents of a stream.

                                                                                        As this method reads the entire stream into memory, it negates the benefits of streams. It's intended for interoperability and convenience, not as the primary way to consume streams.

                                                                                        Parameters

                                                                                        Returns Promise<any[]>

                                                                                        a promise containing an array with the contents of the stream.

                                                                                        -

                                                                                        v17.5.0

                                                                                        +

                                                                                        v17.5.0

                                                                                      • The writable.uncork() method flushes all data buffered since cork was called.

                                                                                        When using writable.cork() and writable.uncork() to manage the buffering of writes to a stream, defer calls to writable.uncork() using process.nextTick(). Doing so allows batching of all writable.write() calls that occur within a given Node.js event @@ -739,8 +742,8 @@

                                                                                        See also: writable.cork().

                                                                                        -

                                                                                        Returns void

                                                                                        v0.11.2

                                                                                        -

                                                                                      • The readable.unpipe() method detaches a Writable stream previously attached +

                                                                                        Returns void

                                                                                        v0.11.2

                                                                                        +

                                                                                      • The readable.unpipe() method detaches a Writable stream previously attached using the pipe method.

                                                                                        If the destination is not specified, then all pipes are detached.

                                                                                        If the destination is specified, but no pipe is set up for it, then @@ -749,8 +752,8 @@

                                                                                        Parameters

                                                                                        • Optionaldestination: WritableStream

                                                                                          Optional specific stream to unpipe

                                                                                          -

                                                                                        Returns this

                                                                                        v0.9.4

                                                                                        -

                                                                                      • Passing chunk as null signals the end of the stream (EOF) and behaves the +

                                                                                      Returns this

                                                                                      v0.9.4

                                                                                      +

                                                                                      • Passing chunk as null signals the end of the stream (EOF) and behaves the same as readable.push(null), after which no more data can be written. The EOF signal is put at the end of the buffer and any buffered data will still be flushed.

                                                                                        @@ -774,8 +777,8 @@ process of performing a read.

                                                                                        Parameters

                                                                                        • chunk: any

                                                                                          Chunk of data to unshift onto the read queue. For streams not operating in object mode, chunk must be a {string}, {Buffer}, {TypedArray}, {DataView} or null. For object mode streams, chunk may be any JavaScript value.

                                                                                          -
                                                                                        • Optionalencoding: BufferEncoding

                                                                                          Encoding of string chunks. Must be a valid Buffer encoding, such as 'utf8' or 'ascii'.

                                                                                          -

                                                                                        Returns void

                                                                                        v0.9.11

                                                                                        +
                                                                                      • Optionalencoding: BufferEncoding

                                                                                        Encoding of string chunks. Must be a valid Buffer encoding, such as 'utf8' or 'ascii'.

                                                                                        +

                                                                                      Returns void

                                                                                      v0.9.11

                                                                                      • Prior to Node.js 0.10, streams did not implement the entire node:stream module API as it is currently defined. (See Compatibility for more information.)

                                                                                        When using an older Node.js library that emits 'data' events and has a pause method that is advisory only, the readable.wrap() method can be used to create a Readable @@ -788,8 +791,8 @@

                                                                                        Parameters

                                                                                        Returns this

                                                                                        v0.9.4

                                                                                        -

                                                                                      • The writable.write() method writes some data to the stream, and calls the +

                                                                                      Returns this

                                                                                      v0.9.4

                                                                                      +

                                                                                      • The writable.write() method writes some data to the stream, and calls the supplied callback once the data has been fully handled. If an error occurs, the callback will be called with the error as its first argument. The callback is called asynchronously and before 'error' is @@ -822,10 +825,10 @@

                                                                                        A Writable stream in object mode will always ignore the encoding argument.

                                                                                        Parameters

                                                                                        • chunk: any

                                                                                          Optional data to write. For streams not operating in object mode, chunk must be a {string}, {Buffer}, {TypedArray} or {DataView}. For object mode streams, chunk may be any JavaScript value other than null.

                                                                                          -
                                                                                        • Optionalcallback: (error: Error) => void

                                                                                          Callback for when this chunk of data is flushed.

                                                                                          -

                                                                                        Returns boolean

                                                                                        false if the stream wishes for the calling code to wait for the 'drain' event to be emitted before continuing to write additional data; otherwise true.

                                                                                        -

                                                                                        v0.9.4

                                                                                        -

                                                                                      • The writable.write() method writes some data to the stream, and calls the +

                                                                                      • Optionalcallback: (error: Error) => void

                                                                                        Callback for when this chunk of data is flushed.

                                                                                        +

                                                                                      Returns boolean

                                                                                      false if the stream wishes for the calling code to wait for the 'drain' event to be emitted before continuing to write additional data; otherwise true.

                                                                                      +

                                                                                      v0.9.4

                                                                                      +

                                                                                    • The writable.write() method writes some data to the stream, and calls the supplied callback once the data has been fully handled. If an error occurs, the callback will be called with the error as its first argument. The callback is called asynchronously and before 'error' is @@ -858,11 +861,11 @@

                                                                                      A Writable stream in object mode will always ignore the encoding argument.

                                                                                      Parameters

                                                                                      • chunk: any

                                                                                        Optional data to write. For streams not operating in object mode, chunk must be a {string}, {Buffer}, {TypedArray} or {DataView}. For object mode streams, chunk may be any JavaScript value other than null.

                                                                                        -
                                                                                      • encoding: BufferEncoding

                                                                                        The encoding, if chunk is a string.

                                                                                        -
                                                                                      • Optionalcallback: (error: Error) => void

                                                                                        Callback for when this chunk of data is flushed.

                                                                                        -

                                                                                      Returns boolean

                                                                                      false if the stream wishes for the calling code to wait for the 'drain' event to be emitted before continuing to write additional data; otherwise true.

                                                                                      -

                                                                                      v0.9.4

                                                                                      -

                                                                                      • Listens once to the abort event on the provided signal.

                                                                                        +
                                                                                      • encoding: BufferEncoding

                                                                                        The encoding, if chunk is a string.

                                                                                        +
                                                                                      • Optionalcallback: (error: Error) => void

                                                                                        Callback for when this chunk of data is flushed.

                                                                                        +

                                                                                      Returns boolean

                                                                                      false if the stream wishes for the calling code to wait for the 'drain' event to be emitted before continuing to write additional data; otherwise true.

                                                                                      +

                                                                                      v0.9.4

                                                                                      +

                                                                                      • Listens once to the abort event on the provided signal.

                                                                                        Listening to the abort event on abort signals is unsafe and may lead to resource leaks since another third party with the signal can call e.stopImmediatePropagation(). Unfortunately Node.js cannot change @@ -876,8 +879,8 @@

                                                                                        Parameters

                                                                                        Returns Disposable

                                                                                        Disposable that removes the abort listener.

                                                                                        -

                                                                                        v20.5.0

                                                                                        -

                                                                                      • A utility method for creating duplex streams.

                                                                                        +

                                                                                        v20.5.0

                                                                                        +

                                                                                      • A utility method for creating duplex streams.

                                                                                        • Stream converts writable stream into writable Duplex and readable stream to Duplex.
                                                                                          • @@ -895,10 +898,10 @@ Duplex will write to the writable and read from the readable.
                                                                                        • Promise converts into readable Duplex. Value null is ignored.
                                                                                        -

                                                                                        Parameters

                                                                                        Returns Duplex

                                                                                        v16.8.0

                                                                                        -

                                                                                      • A utility method for creating a Duplex from a web ReadableStream and WritableStream.

                                                                                        -

                                                                                        Parameters

                                                                                        • duplexStream: { readable: ReadableStream; writable: WritableStream }
                                                                                        • Optionaloptions: Pick<
                                                                                              DuplexOptions,
                                                                                              | "allowHalfOpen"
                                                                                              | "decodeStrings"
                                                                                              | "encoding"
                                                                                              | "highWaterMark"
                                                                                              | "objectMode"
                                                                                              | "signal",
                                                                                          >

                                                                                        Returns Duplex

                                                                                        v17.0.0

                                                                                        -

                                                                                      • Returns a copy of the array of listeners for the event named eventName.

                                                                                        +

                                                                                        Parameters

                                                                                        Returns Duplex

                                                                                        v16.8.0

                                                                                        +

                                                                                      • A utility method for creating a Duplex from a web ReadableStream and WritableStream.

                                                                                        +

                                                                                        Parameters

                                                                                        • duplexStream: { readable: ReadableStream; writable: WritableStream }
                                                                                        • Optionaloptions: Pick<
                                                                                              DuplexOptions,
                                                                                              | "allowHalfOpen"
                                                                                              | "decodeStrings"
                                                                                              | "encoding"
                                                                                              | "highWaterMark"
                                                                                              | "objectMode"
                                                                                              | "signal",
                                                                                          >

                                                                                        Returns Duplex

                                                                                        v17.0.0

                                                                                        +

                                                                                      • Returns a copy of the array of listeners for the event named eventName.

                                                                                        For EventEmitters this behaves exactly the same as calling .listeners on the emitter.

                                                                                        For EventTargets this is the only way to get the event listeners for the @@ -906,8 +909,8 @@ 

                                                                                        import { getEventListeners, EventEmitter } from 'node:events';

                                                                                        {
                                                                                          const ee = new EventEmitter();
                                                                                          const listener = () => console.log('Events are fun');
                                                                                          ee.on('foo', listener);
                                                                                          console.log(getEventListeners(ee, 'foo')); // [ [Function: listener] ]
                                                                                        }
                                                                                        {
                                                                                          const et = new EventTarget();
                                                                                          const listener = () => console.log('Events are fun');
                                                                                          et.addEventListener('foo', listener);
                                                                                          console.log(getEventListeners(et, 'foo')); // [ [Function: listener] ]
                                                                                        }
                                                                                        -

                                                                                        Parameters

                                                                                        Returns Function[]

                                                                                        v15.2.0, v14.17.0

                                                                                        -

                                                                                      • Returns the currently set max amount of listeners.

                                                                                        For EventEmitters this behaves exactly the same as calling .getMaxListeners on the emitter.

                                                                                        For EventTargets this is the only way to get the max event listeners for the @@ -916,16 +919,16 @@ 

                                                                                        import { getMaxListeners, setMaxListeners, EventEmitter } from 'node:events';

                                                                                        {
                                                                                          const ee = new EventEmitter();
                                                                                          console.log(getMaxListeners(ee)); // 10
                                                                                          setMaxListeners(11, ee);
                                                                                          console.log(getMaxListeners(ee)); // 11
                                                                                        }
                                                                                        {
                                                                                          const et = new EventTarget();
                                                                                          console.log(getMaxListeners(et)); // 10
                                                                                          setMaxListeners(11, et);
                                                                                          console.log(getMaxListeners(et)); // 11
                                                                                        }
                                                                                        -

                                                                                        Parameters

                                                                                        Returns number

                                                                                        v19.9.0

                                                                                        -

                                                                                      • A class method that returns the number of listeners for the given eventName registered on the given emitter.

                                                                                        +

                                                                                        Parameters

                                                                                        Returns number

                                                                                        v19.9.0

                                                                                        +

                                                                                      • A class method that returns the number of listeners for the given eventName registered on the given emitter.

                                                                                        import { EventEmitter, listenerCount } from 'node:events';

                                                                                        const myEmitter = new EventEmitter();
                                                                                        myEmitter.on('event', () => {});
                                                                                        myEmitter.on('event', () => {});
                                                                                        console.log(listenerCount(myEmitter, 'event'));
                                                                                        // Prints: 2

                                                                                        Parameters

                                                                                        • emitter: EventEmitter

                                                                                          The emitter to query

                                                                                          -
                                                                                        • eventName: string | symbol

                                                                                          The event name

                                                                                          -

                                                                                        Returns number

                                                                                        v0.9.12

                                                                                        +
                                                                                      • eventName: string | symbol

                                                                                        The event name

                                                                                        +

                                                                                      Returns number

                                                                                      v0.9.12

                                                                                      Since v3.2.0 - Use listenerCount instead.

                                                                                      -
                                                                                      • import { on, EventEmitter } from 'node:events';
                                                                                        import process from 'node:process';

                                                                                        const ee = new EventEmitter();

                                                                                        // Emit later on
                                                                                        process.nextTick(() => {
                                                                                          ee.emit('foo', 'bar');
                                                                                          ee.emit('foo', 42);
                                                                                        });

                                                                                        for await (const event of on(ee, 'foo')) {
                                                                                          // The execution of this inner block is synchronous and it
                                                                                          // processes one event at a time (even with await). Do not use
                                                                                          // if concurrent execution is required.
                                                                                          console.log(event); // prints ['bar'] [42]
                                                                                        }
                                                                                        // Unreachable here
+
                                                                                      • import { on, EventEmitter } from 'node:events';
                                                                                        import process from 'node:process';

                                                                                        const ee = new EventEmitter();

                                                                                        // Emit later on
                                                                                        process.nextTick(() => {
                                                                                          ee.emit('foo', 'bar');
                                                                                          ee.emit('foo', 42);
                                                                                        });

                                                                                        for await (const event of on(ee, 'foo')) {
                                                                                          // The execution of this inner block is synchronous and it
                                                                                          // processes one event at a time (even with await). Do not use
                                                                                          // if concurrent execution is required.
                                                                                          console.log(event); // prints ['bar'] [42]
                                                                                        }
                                                                                        // Unreachable here

                                                                                        Returns an AsyncIterator that iterates eventName events. It will throw @@ -941,8 +944,8 @@

                                                                                        Parameters

                                                                                        Returns AsyncIterator<any[]>

                                                                                        An AsyncIterator that iterates eventName events emitted by the emitter

                                                                                        -

                                                                                        v13.6.0, v12.16.0

                                                                                        -
                                                                                      • import { on, EventEmitter } from 'node:events';
                                                                                        import process from 'node:process';

                                                                                        const ee = new EventEmitter();

                                                                                        // Emit later on
                                                                                        process.nextTick(() => {
                                                                                          ee.emit('foo', 'bar');
                                                                                          ee.emit('foo', 42);
                                                                                        });

                                                                                        for await (const event of on(ee, 'foo')) {
                                                                                          // The execution of this inner block is synchronous and it
                                                                                          // processes one event at a time (even with await). Do not use
                                                                                          // if concurrent execution is required.
                                                                                          console.log(event); // prints ['bar'] [42]
                                                                                        }
                                                                                        // Unreachable here
+
                                                                                        v13.6.0, v12.16.0
                                                                                        
+
                                                                                      • import { on, EventEmitter } from 'node:events';
                                                                                        import process from 'node:process';

                                                                                        const ee = new EventEmitter();

                                                                                        // Emit later on
                                                                                        process.nextTick(() => {
                                                                                          ee.emit('foo', 'bar');
                                                                                          ee.emit('foo', 42);
                                                                                        });

                                                                                        for await (const event of on(ee, 'foo')) {
                                                                                          // The execution of this inner block is synchronous and it
                                                                                          // processes one event at a time (even with await). Do not use
                                                                                          // if concurrent execution is required.
                                                                                          console.log(event); // prints ['bar'] [42]
                                                                                        }
                                                                                        // Unreachable here

                                                                                        Returns an AsyncIterator that iterates eventName events. It will throw @@ -958,8 +961,8 @@

                                                                                        Parameters

                                                                                        Returns AsyncIterator<any[]>

                                                                                        An AsyncIterator that iterates eventName events emitted by the emitter

                                                                                        -

                                                                                        v13.6.0, v12.16.0

                                                                                        -

                                                                                      • Creates a Promise that is fulfilled when the EventEmitter emits the given +

                                                                                        v13.6.0, v12.16.0

                                                                                        +

                                                                                      • Creates a Promise that is fulfilled when the EventEmitter emits the given event or that is rejected if the EventEmitter emits 'error' while waiting. The Promise will resolve with an array of all the arguments emitted to the given event.

                                                                                        @@ -978,8 +981,8 @@ 
                                                                                        import { EventEmitter, once } from 'node:events';

                                                                                        const ee = new EventEmitter();
                                                                                        const ac = new AbortController();

                                                                                        async function foo(emitter, event, signal) {
                                                                                          try {
                                                                                            await once(emitter, event, { signal });
                                                                                            console.log('event emitted!');
                                                                                          } catch (error) {
                                                                                            if (error.name === 'AbortError') {
                                                                                              console.error('Waiting for the event was canceled!');
                                                                                            } else {
                                                                                              console.error('There was an error', error.message);
                                                                                            }
                                                                                          }
                                                                                        }

                                                                                        foo(ee, 'foo', ac.signal);
                                                                                        ac.abort(); // Abort waiting for the event
                                                                                        ee.emit('foo'); // Prints: Waiting for the event was canceled!
                                                                                        -

                                                                                        Parameters

                                                                                        Returns Promise<any[]>

                                                                                        v11.13.0, v10.16.0

                                                                                        -

                                                                                      • Creates a Promise that is fulfilled when the EventEmitter emits the given +

                                                                                        Parameters

                                                                                        Returns Promise<any[]>

                                                                                        v11.13.0, v10.16.0

                                                                                        +

                                                                                      • Creates a Promise that is fulfilled when the EventEmitter emits the given event or that is rejected if the EventEmitter emits 'error' while waiting. The Promise will resolve with an array of all the arguments emitted to the given event.

                                                                                        @@ -998,14 +1001,14 @@ 
                                                                                        import { EventEmitter, once } from 'node:events';

                                                                                        const ee = new EventEmitter();
                                                                                        const ac = new AbortController();

                                                                                        async function foo(emitter, event, signal) {
                                                                                          try {
                                                                                            await once(emitter, event, { signal });
                                                                                            console.log('event emitted!');
                                                                                          } catch (error) {
                                                                                            if (error.name === 'AbortError') {
                                                                                              console.error('Waiting for the event was canceled!');
                                                                                            } else {
                                                                                              console.error('There was an error', error.message);
                                                                                            }
                                                                                          }
                                                                                        }

                                                                                        foo(ee, 'foo', ac.signal);
                                                                                        ac.abort(); // Abort waiting for the event
                                                                                        ee.emit('foo'); // Prints: Waiting for the event was canceled!
                                                                                        -

                                                                                        Parameters

                                                                                        Returns Promise<any[]>

                                                                                        v11.13.0, v10.16.0

                                                                                        -
                                                                                      • import { setMaxListeners, EventEmitter } from 'node:events';

                                                                                        const target = new EventTarget();
                                                                                        const emitter = new EventEmitter();

                                                                                        setMaxListeners(5, target, emitter);
+

                                                                                        Parameters

                                                                                        Returns Promise<any[]>

                                                                                        v11.13.0, v10.16.0

                                                                                        +
                                                                                      • import { setMaxListeners, EventEmitter } from 'node:events';

                                                                                        const target = new EventTarget();
                                                                                        const emitter = new EventEmitter();

                                                                                        setMaxListeners(5, target, emitter);

                                                                                        Parameters

                                                                                        • Optionaln: number

                                                                                          A non-negative number. The maximum number of listeners per EventTarget event.

                                                                                          -
                                                                                        • ...eventTargets: (EventEmitter<DefaultEventMap> | EventTarget)[]

                                                                                          Zero or more {EventTarget} or {EventEmitter} instances. If none are specified, n is set as the default max for all newly created {EventTarget} and {EventEmitter} +

                                                                                        • ...eventTargets: (EventEmitter<DefaultEventMap> | EventTarget)[]

                                                                                          Zero or more {EventTarget} or {EventEmitter} instances. If none are specified, n is set as the default max for all newly created {EventTarget} and {EventEmitter} objects.

                                                                                          -

                                                                                        Returns void

                                                                                        v15.4.0

                                                                                        -

                                                                                      Settings

                                                                                      Member Visibility

                                                                                      On This Page

                                                                                      Constructors
                                                                                      Properties
                                                                                      Methods
                                                                                      +

                                                                                      Returns void

                                                                                      v15.4.0

                                                                                      +

                                                                                      Settings

                                                                                      Member Visibility

                                                                                      On This Page

                                                                                      Constructors
                                                                                      Properties
                                                                                      Methods
                                                                                      diff --git a/docs/classes/_internal_.Stream.Writable.html b/docs/classes/_internal_.Stream.Writable.html index 824e8dae..8fcce801 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.2
                                                                                      ts-lambda-api - v2.5.2
                                                                                        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 @@ -21,6 +21,7 @@ _final _write _writev? +[asyncDispose] [captureRejectionSymbol]? addListener compose @@ -54,42 +55,42 @@ once setMaxListeners toWeb -

                                                                                        Constructors

                                                                                        Properties

                                                                                        closed: boolean

                                                                                        Is true after 'close' has been emitted.

                                                                                        +

                                                                                        Constructors

                                                                                        Properties

                                                                                        closed: boolean

                                                                                        Is true after 'close' has been emitted.

                                                                                        v18.0.0

                                                                                        -
                                                                                        destroyed: boolean

                                                                                        Is true after writable.destroy() has been called.

                                                                                        +
                                                                                        destroyed: boolean

                                                                                        Is true after writable.destroy() has been called.

                                                                                        v8.0.0

                                                                                        -
                                                                                        errored: Error

                                                                                        Returns error if the stream has been destroyed with an error.

                                                                                        +
                                                                                        errored: Error

                                                                                        Returns error if the stream has been destroyed with an error.

                                                                                        v18.0.0

                                                                                        -
                                                                                        writable: boolean

                                                                                        Is true if it is safe to call writable.write(), which means +

                                                                                        writable: boolean

                                                                                        Is true if it is safe to call writable.write(), which means the stream has not been destroyed, errored, or ended.

                                                                                        v11.4.0

                                                                                        -
                                                                                        writableAborted: boolean

                                                                                        Returns whether the stream was destroyed or errored before emitting 'finish'.

                                                                                        +
                                                                                        writableAborted: boolean

                                                                                        Returns whether the stream was destroyed or errored before emitting 'finish'.

                                                                                        v18.0.0, v16.17.0

                                                                                        -
                                                                                        writableCorked: number

                                                                                        Number of times writable.uncork() needs to be +

                                                                                        writableCorked: number

                                                                                        Number of times writable.uncork() needs to be called in order to fully uncork the stream.

                                                                                        v13.2.0, v12.16.0

                                                                                        -
                                                                                        writableEnded: boolean

                                                                                        Is true after writable.end() has been called. This property +

                                                                                        writableEnded: boolean

                                                                                        Is true after writable.end() has been called. This property does not indicate whether the data has been flushed, for this use writable.writableFinished instead.

                                                                                        v12.9.0

                                                                                        -
                                                                                        writableFinished: boolean

                                                                                        Is set to true immediately before the 'finish' event is emitted.

                                                                                        +
                                                                                        writableFinished: boolean

                                                                                        Is set to true immediately before the 'finish' event is emitted.

                                                                                        v12.6.0

                                                                                        -
                                                                                        writableHighWaterMark: number

                                                                                        Return the value of highWaterMark passed when creating this Writable.

                                                                                        +
                                                                                        writableHighWaterMark: number

                                                                                        Return the value of highWaterMark passed when creating this Writable.

                                                                                        v9.3.0

                                                                                        -
                                                                                        writableLength: number

                                                                                        This property contains the number of bytes (or objects) in the queue +

                                                                                        writableLength: number

                                                                                        This property contains the number of bytes (or objects) in the queue ready to be written. The value provides introspection data regarding the status of the highWaterMark.

                                                                                        v9.4.0

                                                                                        -
                                                                                        writableNeedDrain: boolean

                                                                                        Is true if the stream's buffer has been full and stream will emit 'drain'.

                                                                                        +
                                                                                        writableNeedDrain: boolean

                                                                                        Is true if the stream's buffer has been full and stream will emit 'drain'.

                                                                                        v15.2.0, v14.17.0

                                                                                        -
                                                                                        writableObjectMode: boolean

                                                                                        Getter for the property objectMode of a given Writable stream.

                                                                                        +
                                                                                        writableObjectMode: boolean

                                                                                        Getter for the property objectMode of a given Writable stream.

                                                                                        v12.3.0

                                                                                        -
                                                                                        captureRejections: boolean

                                                                                        Value: boolean

                                                                                        +
                                                                                        captureRejections: boolean

                                                                                        Value: boolean

                                                                                        Change the default captureRejections option on all new EventEmitter objects.

                                                                                        v13.4.0, v12.16.0

                                                                                        -
                                                                                        captureRejectionSymbol: typeof captureRejectionSymbol

                                                                                        Value: Symbol.for('nodejs.rejection')

                                                                                        +
                                                                                        captureRejectionSymbol: typeof captureRejectionSymbol

                                                                                        Value: Symbol.for('nodejs.rejection')

                                                                                        See how to write a custom rejection handler.

                                                                                        v13.4.0, v12.16.0

                                                                                        -
                                                                                        defaultMaxListeners: number

                                                                                        By default, a maximum of 10 listeners can be registered for any single +

                                                                                        defaultMaxListeners: number

                                                                                        By default, a maximum of 10 listeners can be registered for any single event. This limit can be changed for individual EventEmitter instances using the emitter.setMaxListeners(n) method. To change the default for allEventEmitter instances, the events.defaultMaxListeners property @@ -114,11 +115,14 @@ listeners, respectively. Its name property is set to 'MaxListenersExceededWarning'.

                                                                                        v0.11.2

                                                                                        -
                                                                                        errorMonitor: typeof errorMonitor

                                                                                        This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

                                                                                        +
                                                                                        errorMonitor: typeof errorMonitor

                                                                                        This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

                                                                                        Installing a listener using this symbol does not change the behavior once an 'error' event is emitted. Therefore, the process will still crash if no regular 'error' listener is installed.

                                                                                        v13.6.0, v12.17.0

                                                                                        -

                                                                                        Methods

                                                                                        Optional_construct

                                                                                        • _construct(callback: (error?: Error) => void): void

                                                                                          Parameters

                                                                                          • callback: (error?: Error) => void

                                                                                          Returns void

                                                                                        _destroy

                                                                                        • _destroy(error: Error, callback: (error?: Error) => void): void

                                                                                          Parameters

                                                                                          • error: Error
                                                                                          • callback: (error?: Error) => void

                                                                                          Returns void

                                                                                        _final

                                                                                        • _final(callback: (error?: Error) => void): void

                                                                                          Parameters

                                                                                          • callback: (error?: Error) => void

                                                                                          Returns void

                                                                                        _write

                                                                                        • _write(
                                                                                              chunk: any,
                                                                                              encoding: BufferEncoding,
                                                                                              callback: (error?: Error) => void,
                                                                                          ): void

                                                                                          Parameters

                                                                                          Returns void

                                                                                        Optional_writev

                                                                                        • _writev(
                                                                                              chunks: { chunk: any; encoding: BufferEncoding }[],
                                                                                              callback: (error?: Error) => void,
                                                                                          ): void

                                                                                          Parameters

                                                                                          • chunks: { chunk: any; encoding: BufferEncoding }[]
                                                                                          • callback: (error?: Error) => void

                                                                                          Returns void

                                                                                        • Event emitter +

                                                                                        Methods

                                                                                        Optional_construct

                                                                                        • _construct?(callback: (error?: Error) => void): void

                                                                                          Parameters

                                                                                          • callback: (error?: Error) => void

                                                                                          Returns void

                                                                                        _destroy

                                                                                        • _destroy(error: Error, callback: (error?: Error) => void): void

                                                                                          Parameters

                                                                                          • error: Error
                                                                                          • callback: (error?: Error) => void

                                                                                          Returns void

                                                                                        _final

                                                                                        • _final(callback: (error?: Error) => void): void

                                                                                          Parameters

                                                                                          • callback: (error?: Error) => void

                                                                                          Returns void

                                                                                        _write

                                                                                        • _write(
                                                                                              chunk: any,
                                                                                              encoding: BufferEncoding,
                                                                                              callback: (error?: Error) => void,
                                                                                          ): void

                                                                                          Parameters

                                                                                          Returns void

                                                                                        Optional_writev

                                                                                        • _writev?(
                                                                                              chunks: { chunk: any; encoding: BufferEncoding }[],
                                                                                              callback: (error?: Error) => void,
                                                                                          ): void

                                                                                          Parameters

                                                                                          • chunks: { chunk: any; encoding: BufferEncoding }[]
                                                                                          • callback: (error?: Error) => void

                                                                                          Returns void

                                                                                        • Calls writable.destroy() with an AbortError and returns +a promise that fulfills when the stream is finished.

                                                                                          +

                                                                                          Returns Promise<void>

                                                                                          v22.4.0, v20.16.0

                                                                                          +

                                                                                        • Event emitter The defined events on documents including:

                                                                                          1. close
                                                                                            2. @@ -128,7 +132,7 @@
                                                                                          2. pipe
                                                                                          3. unpipe
                                                                                          -

                                                                                          Parameters

                                                                                          • event: "close"
                                                                                          • listener: () => void

                                                                                          Returns this

                                                                                        • Event emitter +

                                                                                          Parameters

                                                                                          • event: "close"
                                                                                          • listener: () => void

                                                                                          Returns this

                                                                                        • Event emitter The defined events on documents including:

                                                                                          1. close
                                                                                            2. @@ -138,7 +142,7 @@
                                                                                          2. pipe
                                                                                          3. unpipe
                                                                                          -

                                                                                          Parameters

                                                                                          • event: "drain"
                                                                                          • listener: () => void

                                                                                          Returns this

                                                                                        • Event emitter +

                                                                                          Parameters

                                                                                          • event: "drain"
                                                                                          • listener: () => void

                                                                                          Returns this

                                                                                        • Event emitter The defined events on documents including:

                                                                                          1. close
                                                                                            2. @@ -148,7 +152,7 @@
                                                                                          2. pipe
                                                                                          3. unpipe
                                                                                          -

                                                                                          Parameters

                                                                                          • event: "error"
                                                                                          • listener: (err: Error) => void

                                                                                          Returns this

                                                                                        • Event emitter +

                                                                                          Parameters

                                                                                          • event: "error"
                                                                                          • listener: (err: Error) => void

                                                                                          Returns this

                                                                                        • Event emitter The defined events on documents including:

                                                                                          1. close
                                                                                            2. @@ -158,7 +162,7 @@
                                                                                          2. pipe
                                                                                          3. unpipe
                                                                                          -

                                                                                          Parameters

                                                                                          • event: "finish"
                                                                                          • listener: () => void

                                                                                          Returns this

                                                                                        • Event emitter +

                                                                                          Parameters

                                                                                          • event: "finish"
                                                                                          • listener: () => void

                                                                                          Returns this

                                                                                        • Event emitter The defined events on documents including:

                                                                                          1. close
                                                                                            2. @@ -168,7 +172,7 @@
                                                                                          2. pipe
                                                                                          3. unpipe
                                                                                          -

                                                                                          Parameters

                                                                                          • event: "pipe"
                                                                                          • listener: (src: Readable) => void

                                                                                          Returns this

                                                                                        • Event emitter +

                                                                                          Parameters

                                                                                          • event: "pipe"
                                                                                          • listener: (src: Readable) => void

                                                                                          Returns this

                                                                                        • Event emitter The defined events on documents including:

                                                                                          1. close
                                                                                            2. @@ -178,7 +182,7 @@
                                                                                          2. pipe
                                                                                          3. unpipe
                                                                                          -

                                                                                          Parameters

                                                                                          • event: "unpipe"
                                                                                          • listener: (src: Readable) => void

                                                                                          Returns this

                                                                                        • Event emitter +

                                                                                          Parameters

                                                                                          • event: "unpipe"
                                                                                          • listener: (src: Readable) => void

                                                                                          Returns this

                                                                                        • Event emitter The defined events on documents including:

                                                                                          1. close
                                                                                            2. @@ -188,7 +192,7 @@
                                                                                          2. pipe
                                                                                          3. unpipe
                                                                                          -

                                                                                          Parameters

                                                                                          • event: string | symbol
                                                                                          • listener: (...args: any[]) => void

                                                                                          Returns this

                                                                                        • The writable.cork() method forces all written data to be buffered in memory. +

                                                                                          Parameters

                                                                                          • event: string | symbol
                                                                                          • listener: (...args: any[]) => void

                                                                                          Returns this

                                                                                        • The writable.cork() method forces all written data to be buffered in memory. The buffered data will be flushed when either the uncork or end methods are called.

                                                                                          The primary intent of writable.cork() is to accommodate a situation in which several small chunks are written to the stream in rapid succession. Instead of @@ -197,8 +201,8 @@ situation where data is being buffered while waiting for the first small chunk to be processed. However, use of writable.cork() without implementing writable._writev() may have an adverse effect on throughput.

                                                                                          See also: writable.uncork(), writable._writev().

                                                                                          -

                                                                                          Returns void

                                                                                          v0.11.2

                                                                                          -

                                                                                        • Destroy the stream. Optionally emit an 'error' event, and emit a 'close' event (unless emitClose is set to false). After this call, the writable +

                                                                                          Returns void

                                                                                          v0.11.2

                                                                                          +

                                                                                        • Destroy the stream. Optionally emit an 'error' event, and emit a 'close' event (unless emitClose is set to false). After this call, the writable stream has ended and subsequent calls to write() or end() will result in an ERR_STREAM_DESTROYED error. This is a destructive and immediate way to destroy a stream. Previous calls to write() may not have drained, and may trigger an ERR_STREAM_DESTROYED error. @@ -209,15 +213,15 @@

                                                                                          Implementors should not override this method, but instead implement writable._destroy().

                                                                                          Parameters

                                                                                          • Optionalerror: Error

                                                                                            Optional, an error to emit with 'error' event.

                                                                                            -

                                                                                          Returns this

                                                                                          v8.0.0

                                                                                          -

                                                                                        • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments +

                                                                                        Returns this

                                                                                        v8.0.0

                                                                                        +

                                                                                        • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

                                                                                          Returns true if the event had listeners, false otherwise.

                                                                                          import { EventEmitter } from 'node:events';
                                                                                          const myEmitter = new EventEmitter();

                                                                                          // First listener
                                                                                          myEmitter.on('event', function firstListener() {
                                                                                            console.log('Helloooo! first listener');
                                                                                          });
                                                                                          // Second listener
                                                                                          myEmitter.on('event', function secondListener(arg1, arg2) {
                                                                                            console.log(`event with parameters ${arg1}, ${arg2} in second listener`);
                                                                                          });
                                                                                          // Third listener
                                                                                          myEmitter.on('event', function thirdListener(...args) {
                                                                                            const parameters = args.join(', ');
                                                                                            console.log(`event with parameters ${parameters} in third listener`);
                                                                                          });

                                                                                          console.log(myEmitter.listeners('event'));

                                                                                          myEmitter.emit('event', 1, 2, 3, 4, 5);

                                                                                          // Prints:
                                                                                          // [
                                                                                          //   [Function: firstListener],
                                                                                          //   [Function: secondListener],
                                                                                          //   [Function: thirdListener]
                                                                                          // ]
                                                                                          // Helloooo! first listener
                                                                                          // event with parameters 1, 2 in second listener
                                                                                          // event with parameters 1, 2, 3, 4, 5 in third listener
                                                                                          -

                                                                                          Parameters

                                                                                          • event: "close"

                                                                                          Returns boolean

                                                                                          v0.1.26

                                                                                          -

                                                                                        • Parameters

                                                                                          • event: "drain"

                                                                                          Returns boolean

                                                                                        • Parameters

                                                                                          • event: "error"
                                                                                          • err: Error

                                                                                          Returns boolean

                                                                                        • Parameters

                                                                                          • event: "finish"

                                                                                          Returns boolean

                                                                                        • Parameters

                                                                                          Returns boolean

                                                                                        • Parameters

                                                                                          Returns boolean

                                                                                        • Parameters

                                                                                          • event: string | symbol
                                                                                          • ...args: any[]

                                                                                          Returns boolean

                                                                                        • Calling the writable.end() method signals that no more data will be written +

                                                                                          Parameters

                                                                                          • event: "close"

                                                                                          Returns boolean

                                                                                          v0.1.26

                                                                                          +

                                                                                        • Parameters

                                                                                          • event: "drain"

                                                                                          Returns boolean

                                                                                        • Parameters

                                                                                          • event: "error"
                                                                                          • err: Error

                                                                                          Returns boolean

                                                                                        • Parameters

                                                                                          • event: "finish"

                                                                                          Returns boolean

                                                                                        • Parameters

                                                                                          Returns boolean

                                                                                        • Parameters

                                                                                          Returns boolean

                                                                                        • Parameters

                                                                                          • event: string | symbol
                                                                                          • ...args: any[]

                                                                                          Returns boolean

                                                                                        • Calling the writable.end() method signals that no more data will be written to the Writable. The optional chunk and encoding arguments allow one final additional chunk of data to be written immediately before closing the stream.

                                                                                          @@ -225,8 +229,8 @@ 
                                                                                          // Write 'hello, ' and then end with 'world!'.
                                                                                          import fs from 'node:fs';
                                                                                          const file = fs.createWriteStream('example.txt');
                                                                                          file.write('hello, ');
                                                                                          file.end('world!');
                                                                                          // Writing more now is not allowed!
                                                                                          -

                                                                                          Parameters

                                                                                          • Optionalcb: () => void

                                                                                          Returns this

                                                                                          v0.9.4

                                                                                          -

                                                                                        • Calling the writable.end() method signals that no more data will be written +

                                                                                          Parameters

                                                                                          • Optionalcb: () => void

                                                                                          Returns this

                                                                                          v0.9.4

                                                                                          +

                                                                                        • Calling the writable.end() method signals that no more data will be written to the Writable. The optional chunk and encoding arguments allow one final additional chunk of data to be written immediately before closing the stream.

                                                                                          @@ -236,8 +240,8 @@

                                                                                          Parameters

                                                                                          • chunk: any

                                                                                            Optional data to write. For streams not operating in object mode, chunk must be a {string}, {Buffer}, {TypedArray} or {DataView}. For object mode streams, chunk may be any JavaScript value other than null.

                                                                                            -
                                                                                          • Optionalcb: () => void

                                                                                          Returns this

                                                                                          v0.9.4

                                                                                          -

                                                                                        • Calling the writable.end() method signals that no more data will be written +

                                                                                        • Optionalcb: () => void

                                                                                        Returns this

                                                                                        v0.9.4

                                                                                        +

                                                                                      • Calling the writable.end() method signals that no more data will be written to the Writable. The optional chunk and encoding arguments allow one final additional chunk of data to be written immediately before closing the stream.

                                                                                        @@ -247,31 +251,31 @@

                                                                                        Parameters

                                                                                        • chunk: any

                                                                                          Optional data to write. For streams not operating in object mode, chunk must be a {string}, {Buffer}, {TypedArray} or {DataView}. For object mode streams, chunk may be any JavaScript value other than null.

                                                                                          -
                                                                                        • encoding: BufferEncoding

                                                                                          The encoding if chunk is a string

                                                                                          -
                                                                                        • Optionalcb: () => void

                                                                                        Returns this

                                                                                        v0.9.4

                                                                                        -

                                                                                        • Returns an array listing the events for which the emitter has registered +

                                                                                        • encoding: BufferEncoding

                                                                                          The encoding if chunk is a string

                                                                                          +
                                                                                        • Optionalcb: () => void

                                                                                        Returns this

                                                                                        v0.9.4

                                                                                        +

                                                                                        • Returns an array listing the events for which the emitter has registered listeners. The values in the array are strings or Symbols.

                                                                                          import { EventEmitter } from 'node:events';

                                                                                          const myEE = new EventEmitter();
                                                                                          myEE.on('foo', () => {});
                                                                                          myEE.on('bar', () => {});

                                                                                          const sym = Symbol('symbol');
                                                                                          myEE.on(sym, () => {});

                                                                                          console.log(myEE.eventNames());
                                                                                          // Prints: [ 'foo', 'bar', Symbol(symbol) ]
                                                                                          -

                                                                                          Returns (string | symbol)[]

                                                                                          v6.0.0

                                                                                          -

                                                                                        • Returns the current max listener value for the EventEmitter which is either +

                                                                                          Returns (string | symbol)[]

                                                                                          v6.0.0

                                                                                          +

                                                                                        • Returns the number of listeners listening for the event named eventName. +

                                                                                          Returns number

                                                                                          v1.0.0

                                                                                          +

                                                                                        • Returns the number of listeners listening for the event named eventName. If listener is provided, it will return how many times the listener is found in the list of the listeners of the event.

                                                                                          Type Parameters

                                                                                          • K

                                                                                          Parameters

                                                                                          • eventName: string | symbol

                                                                                            The name of the event being listened for

                                                                                            -
                                                                                          • Optionallistener: Function

                                                                                            The event handler function

                                                                                            -

                                                                                          Returns number

                                                                                          v3.2.0

                                                                                          -

                                                                                        • Returns a copy of the array of listeners for the event named eventName.

                                                                                          +
                                                                                        • Optionallistener: Function

                                                                                          The event handler function

                                                                                          +

                                                                                        Returns number

                                                                                        v3.2.0

                                                                                        +

                                                                                        • Returns a copy of the array of listeners for the event named eventName.

                                                                                          server.on('connection', (stream) => {
                                                                                            console.log('someone connected!');
                                                                                          });
                                                                                          console.log(util.inspect(server.listeners('connection')));
                                                                                          // Prints: [ [Function] ]
                                                                                          -

                                                                                          Type Parameters

                                                                                          • K

                                                                                          Parameters

                                                                                          • eventName: string | symbol

                                                                                          Returns Function[]

                                                                                          v0.1.26

                                                                                          -

                                                                                        • Alias for emitter.removeListener().

                                                                                          -

                                                                                          Type Parameters

                                                                                          • K

                                                                                          Parameters

                                                                                          • eventName: string | symbol
                                                                                          • listener: (...args: any[]) => void

                                                                                          Returns this

                                                                                          v10.0.0

                                                                                          -

                                                                                        • Adds the listener function to the end of the listeners array for the event +

                                                                                          Type Parameters

                                                                                          • K

                                                                                          Parameters

                                                                                          • eventName: string | symbol

                                                                                          Returns Function[]

                                                                                          v0.1.26

                                                                                          +

                                                                                        • Alias for emitter.removeListener().

                                                                                          +

                                                                                          Type Parameters

                                                                                          • K

                                                                                          Parameters

                                                                                          • eventName: string | symbol
                                                                                          • listener: (...args: any[]) => void

                                                                                          Returns this

                                                                                          v10.0.0

                                                                                          +

                                                                                        • Adds the listener function to the end of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.

                                                                                          @@ -285,8 +289,8 @@

                                                                                          Parameters

                                                                                          • event: "close"
                                                                                          • listener: () => void

                                                                                            The callback function

                                                                                            -

                                                                                          Returns this

                                                                                          v0.1.101

                                                                                          -

                                                                                        • Parameters

                                                                                          • event: "drain"
                                                                                          • listener: () => void

                                                                                          Returns this

                                                                                        • Parameters

                                                                                          • event: "error"
                                                                                          • listener: (err: Error) => void

                                                                                          Returns this

                                                                                        • Parameters

                                                                                          • event: "finish"
                                                                                          • listener: () => void

                                                                                          Returns this

                                                                                        • Parameters

                                                                                          • event: "pipe"
                                                                                          • listener: (src: Readable) => void

                                                                                          Returns this

                                                                                        • Parameters

                                                                                          • event: "unpipe"
                                                                                          • listener: (src: Readable) => void

                                                                                          Returns this

                                                                                        • Parameters

                                                                                          • event: string | symbol
                                                                                          • listener: (...args: any[]) => void

                                                                                          Returns this

                                                                                        • Adds a one-time listener function for the event named eventName. The +

                                                                                        Returns this

                                                                                        v0.1.101

                                                                                        +

                                                                                      • Parameters

                                                                                        • event: "drain"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "error"
                                                                                        • listener: (err: Error) => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "finish"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "pipe"
                                                                                        • listener: (src: Readable) => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "unpipe"
                                                                                        • listener: (src: Readable) => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: string | symbol
                                                                                        • listener: (...args: any[]) => void

                                                                                        Returns this

                                                                                        • Adds a one-time listener function for the event named eventName. The next time eventName is triggered, this listener is removed and then invoked.

                                                                                          server.once('connection', (stream) => {
                                                                                            console.log('Ah, we have our first user!');
                                                                                          });
                                                                                          @@ -298,8 +302,8 @@

                                                                                          Parameters

                                                                                          • event: "close"
                                                                                          • listener: () => void

                                                                                            The callback function

                                                                                            -

                                                                                          Returns this

                                                                                          v0.3.0

                                                                                          -

                                                                                        • Parameters

                                                                                          • event: "drain"
                                                                                          • listener: () => void

                                                                                          Returns this

                                                                                        • Parameters

                                                                                          • event: "error"
                                                                                          • listener: (err: Error) => void

                                                                                          Returns this

                                                                                        • Parameters

                                                                                          • event: "finish"
                                                                                          • listener: () => void

                                                                                          Returns this

                                                                                        • Parameters

                                                                                          • event: "pipe"
                                                                                          • listener: (src: Readable) => void

                                                                                          Returns this

                                                                                        • Parameters

                                                                                          • event: "unpipe"
                                                                                          • listener: (src: Readable) => void

                                                                                          Returns this

                                                                                        • Parameters

                                                                                          • event: string | symbol
                                                                                          • listener: (...args: any[]) => void

                                                                                          Returns this

                                                                                        • Type Parameters

                                                                                          Parameters

                                                                                          • destination: T
                                                                                          • Optionaloptions: { end?: boolean }

                                                                                          Returns T

                                                                                        • Adds the listener function to the beginning of the listeners array for the +

                                                                                        Returns this

                                                                                        v0.3.0

                                                                                        +

                                                                                      • Parameters

                                                                                        • event: "drain"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "error"
                                                                                        • listener: (err: Error) => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "finish"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "pipe"
                                                                                        • listener: (src: Readable) => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "unpipe"
                                                                                        • listener: (src: Readable) => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: string | symbol
                                                                                        • listener: (...args: any[]) => void

                                                                                        Returns this

                                                                                        • Type Parameters

                                                                                          Parameters

                                                                                          • destination: T
                                                                                          • Optionaloptions: { end?: boolean }

                                                                                          Returns T

                                                                                        • Adds the listener function to the beginning of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.

                                                                                          @@ -308,28 +312,28 @@

                                                                                          Returns a reference to the EventEmitter, so that calls can be chained.

                                                                                          Parameters

                                                                                          • event: "close"
                                                                                          • listener: () => void

                                                                                            The callback function

                                                                                            -

                                                                                          Returns this

                                                                                          v6.0.0

                                                                                          -

                                                                                        • Parameters

                                                                                          • event: "drain"
                                                                                          • listener: () => void

                                                                                          Returns this

                                                                                        • Parameters

                                                                                          • event: "error"
                                                                                          • listener: (err: Error) => void

                                                                                          Returns this

                                                                                        • Parameters

                                                                                          • event: "finish"
                                                                                          • listener: () => void

                                                                                          Returns this

                                                                                        • Parameters

                                                                                          • event: "pipe"
                                                                                          • listener: (src: Readable) => void

                                                                                          Returns this

                                                                                        • Parameters

                                                                                          • event: "unpipe"
                                                                                          • listener: (src: Readable) => void

                                                                                          Returns this

                                                                                        • Parameters

                                                                                          • event: string | symbol
                                                                                          • listener: (...args: any[]) => void

                                                                                          Returns this

                                                                                        • Adds a one-timelistener function for the event named eventName to the beginning of the listeners array. The next time eventName is triggered, this +

                                                                                        Returns this

                                                                                        v6.0.0

                                                                                        +

                                                                                      • Parameters

                                                                                        • event: "drain"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "error"
                                                                                        • listener: (err: Error) => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "finish"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "pipe"
                                                                                        • listener: (src: Readable) => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "unpipe"
                                                                                        • listener: (src: Readable) => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: string | symbol
                                                                                        • listener: (...args: any[]) => void

                                                                                        Returns this

                                                                                        • Adds a one-timelistener function for the event named eventName to the beginning of the listeners array. The next time eventName is triggered, this listener is removed, and then invoked.

                                                                                          server.prependOnceListener('connection', (stream) => {
                                                                                            console.log('Ah, we have our first user!');
                                                                                          });

                                                                                          Returns a reference to the EventEmitter, so that calls can be chained.

                                                                                          Parameters

                                                                                          • event: "close"
                                                                                          • listener: () => void

                                                                                            The callback function

                                                                                            -

                                                                                          Returns this

                                                                                          v6.0.0

                                                                                          -

                                                                                        • Parameters

                                                                                          • event: "drain"
                                                                                          • listener: () => void

                                                                                          Returns this

                                                                                        • Parameters

                                                                                          • event: "error"
                                                                                          • listener: (err: Error) => void

                                                                                          Returns this

                                                                                        • Parameters

                                                                                          • event: "finish"
                                                                                          • listener: () => void

                                                                                          Returns this

                                                                                        • Parameters

                                                                                          • event: "pipe"
                                                                                          • listener: (src: Readable) => void

                                                                                          Returns this

                                                                                        • Parameters

                                                                                          • event: "unpipe"
                                                                                          • listener: (src: Readable) => void

                                                                                          Returns this

                                                                                        • Parameters

                                                                                          • event: string | symbol
                                                                                          • listener: (...args: any[]) => void

                                                                                          Returns this

                                                                                        • Returns a copy of the array of listeners for the event named eventName, +

                                                                                        Returns this

                                                                                        v6.0.0

                                                                                        +

                                                                                      • Parameters

                                                                                        • event: "drain"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "error"
                                                                                        • listener: (err: Error) => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "finish"
                                                                                        • listener: () => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "pipe"
                                                                                        • listener: (src: Readable) => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: "unpipe"
                                                                                        • listener: (src: Readable) => void

                                                                                        Returns this

                                                                                      • Parameters

                                                                                        • event: string | symbol
                                                                                        • listener: (...args: any[]) => void

                                                                                        Returns this

                                                                                        • Returns a copy of the array of listeners for the event named eventName, including any wrappers (such as those created by .once()).

                                                                                          import { EventEmitter } from 'node:events';
                                                                                          const emitter = new EventEmitter();
                                                                                          emitter.once('log', () => console.log('log once'));

                                                                                          // Returns a new Array with a function `onceWrapper` which has a property
                                                                                          // `listener` which contains the original listener bound above
                                                                                          const listeners = emitter.rawListeners('log');
                                                                                          const logFnWrapper = listeners[0];

                                                                                          // Logs "log once" to the console and does not unbind the `once` event
                                                                                          logFnWrapper.listener();

                                                                                          // Logs "log once" to the console and removes the listener
                                                                                          logFnWrapper();

                                                                                          emitter.on('log', () => console.log('log persistently'));
                                                                                          // Will return a new Array with a single function bound by `.on()` above
                                                                                          const newListeners = emitter.rawListeners('log');

                                                                                          // Logs "log persistently" twice
                                                                                          newListeners[0]();
                                                                                          emitter.emit('log');
                                                                                          -

                                                                                          Type Parameters

                                                                                          • K

                                                                                          Parameters

                                                                                          • eventName: string | symbol

                                                                                          Returns Function[]

                                                                                          v9.4.0

                                                                                          -

                                                                                        • Removes all listeners, or those of the specified eventName.

                                                                                          +

                                                                                          Type Parameters

                                                                                          • K

                                                                                          Parameters

                                                                                          • eventName: string | symbol

                                                                                          Returns Function[]

                                                                                          v9.4.0

                                                                                          +

                                                                                        • Removes all listeners, or those of the specified eventName.

                                                                                          It is bad practice to remove listeners added elsewhere in the code, particularly when the EventEmitter instance was created by some other component or module (e.g. sockets or file streams).

                                                                                          Returns a reference to the EventEmitter, so that calls can be chained.

                                                                                          -

                                                                                          Parameters

                                                                                          • OptionaleventName: string | symbol

                                                                                          Returns this

                                                                                          v0.1.26

                                                                                          -

                                                                                        • Removes the specified listener from the listener array for the event named eventName.

                                                                                          +

                                                                                          Parameters

                                                                                          • OptionaleventName: string | symbol

                                                                                          Returns this

                                                                                          v0.1.26

                                                                                          +

                                                                                        • Removes the specified listener from the listener array for the event named eventName.

                                                                                          const callback = (stream) => {
                                                                                            console.log('someone connected!');
                                                                                          };
                                                                                          server.on('connection', callback);
                                                                                          // ...
                                                                                          server.removeListener('connection', callback);
                                                                                          @@ -355,17 +359,17 @@

                                                                                          Returns a reference to the EventEmitter, so that calls can be chained.

                                                                                          -

                                                                                          Parameters

                                                                                          • event: "close"
                                                                                          • listener: () => void

                                                                                          Returns this

                                                                                          v0.1.26

                                                                                          -

                                                                                        • Parameters

                                                                                          • event: "drain"
                                                                                          • listener: () => void

                                                                                          Returns this

                                                                                        • Parameters

                                                                                          • event: "error"
                                                                                          • listener: (err: Error) => void

                                                                                          Returns this

                                                                                        • Parameters

                                                                                          • event: "finish"
                                                                                          • listener: () => void

                                                                                          Returns this

                                                                                        • Parameters

                                                                                          • event: "pipe"
                                                                                          • listener: (src: Readable) => void

                                                                                          Returns this

                                                                                        • Parameters

                                                                                          • event: "unpipe"
                                                                                          • listener: (src: Readable) => void

                                                                                          Returns this

                                                                                        • Parameters

                                                                                          • event: string | symbol
                                                                                          • listener: (...args: any[]) => void

                                                                                          Returns this

                                                                                        • The writable.setDefaultEncoding() method sets the default encoding for a Writable stream.

                                                                                          +

                                                                                          Parameters

                                                                                          • event: "close"
                                                                                          • listener: () => void

                                                                                          Returns this

                                                                                          v0.1.26

                                                                                          +

                                                                                        • Parameters

                                                                                          • event: "drain"
                                                                                          • listener: () => void

                                                                                          Returns this

                                                                                        • Parameters

                                                                                          • event: "error"
                                                                                          • listener: (err: Error) => void

                                                                                          Returns this

                                                                                        • Parameters

                                                                                          • event: "finish"
                                                                                          • listener: () => void

                                                                                          Returns this

                                                                                        • Parameters

                                                                                          • event: "pipe"
                                                                                          • listener: (src: Readable) => void

                                                                                          Returns this

                                                                                        • Parameters

                                                                                          • event: "unpipe"
                                                                                          • listener: (src: Readable) => void

                                                                                          Returns this

                                                                                        • Parameters

                                                                                          • event: string | symbol
                                                                                          • listener: (...args: any[]) => void

                                                                                          Returns this

                                                                                        • The writable.setDefaultEncoding() method sets the default encoding for a Writable stream.

                                                                                          Parameters

                                                                                          Returns this

                                                                                          v0.11.15

                                                                                          -

                                                                                        • By default EventEmitters will print a warning if more than 10 listeners are +

                                                                                        Returns this

                                                                                        v0.11.15

                                                                                        +

                                                                                        • By default EventEmitters will print a warning if more than 10 listeners are added for a particular event. This is a useful default that helps finding memory leaks. The emitter.setMaxListeners() method allows the limit to be modified for this specific EventEmitter instance. The value can be set to Infinity (or 0) to indicate an unlimited number of listeners.

                                                                                          Returns a reference to the EventEmitter, so that calls can be chained.

                                                                                          -

                                                                                          Parameters

                                                                                          • n: number

                                                                                          Returns this

                                                                                          v0.3.5

                                                                                          -

                                                                                        • The writable.uncork() method flushes all data buffered since cork was called.

                                                                                          +

                                                                                          Parameters

                                                                                          • n: number

                                                                                          Returns this

                                                                                          v0.3.5

                                                                                          +

                                                                                        • The writable.uncork() method flushes all data buffered since cork was called.

                                                                                          When using writable.cork() and writable.uncork() to manage the buffering of writes to a stream, defer calls to writable.uncork() using process.nextTick(). Doing so allows batching of all writable.write() calls that occur within a given Node.js event loop phase.

                                                                                          @@ -379,8 +383,8 @@

                                                                                          See also: writable.cork().

                                                                                          -

                                                                                          Returns void

                                                                                          v0.11.2

                                                                                          -

                                                                                        • The writable.write() method writes some data to the stream, and calls the +

                                                                                          Returns void

                                                                                          v0.11.2

                                                                                          +

                                                                                        • The writable.write() method writes some data to the stream, and calls the supplied callback once the data has been fully handled. If an error occurs, the callback will be called with the error as its first argument. The callback is called asynchronously and before 'error' is @@ -413,10 +417,10 @@

                                                                                          A Writable stream in object mode will always ignore the encoding argument.

                                                                                          Parameters

                                                                                          • chunk: any

                                                                                            Optional data to write. For streams not operating in object mode, chunk must be a {string}, {Buffer}, {TypedArray} or {DataView}. For object mode streams, chunk may be any JavaScript value other than null.

                                                                                            -
                                                                                          • Optionalcallback: (error: Error) => void

                                                                                            Callback for when this chunk of data is flushed.

                                                                                            -

                                                                                          Returns boolean

                                                                                          false if the stream wishes for the calling code to wait for the 'drain' event to be emitted before continuing to write additional data; otherwise true.

                                                                                          -

                                                                                          v0.9.4

                                                                                          -

                                                                                        • The writable.write() method writes some data to the stream, and calls the +

                                                                                        • Optionalcallback: (error: Error) => void

                                                                                          Callback for when this chunk of data is flushed.

                                                                                          +

                                                                                        Returns boolean

                                                                                        false if the stream wishes for the calling code to wait for the 'drain' event to be emitted before continuing to write additional data; otherwise true.

                                                                                        +

                                                                                        v0.9.4

                                                                                        +

                                                                                      • The writable.write() method writes some data to the stream, and calls the supplied callback once the data has been fully handled. If an error occurs, the callback will be called with the error as its first argument. The callback is called asynchronously and before 'error' is @@ -449,11 +453,11 @@

                                                                                        A Writable stream in object mode will always ignore the encoding argument.

                                                                                        Parameters

                                                                                        • chunk: any

                                                                                          Optional data to write. For streams not operating in object mode, chunk must be a {string}, {Buffer}, {TypedArray} or {DataView}. For object mode streams, chunk may be any JavaScript value other than null.

                                                                                          -
                                                                                        • encoding: BufferEncoding

                                                                                          The encoding, if chunk is a string.

                                                                                          -
                                                                                        • Optionalcallback: (error: Error) => void

                                                                                          Callback for when this chunk of data is flushed.

                                                                                          -

                                                                                        Returns boolean

                                                                                        false if the stream wishes for the calling code to wait for the 'drain' event to be emitted before continuing to write additional data; otherwise true.

                                                                                        -

                                                                                        v0.9.4

                                                                                        -

                                                                                        • Listens once to the abort event on the provided signal.

                                                                                          +
                                                                                        • encoding: BufferEncoding

                                                                                          The encoding, if chunk is a string.

                                                                                          +
                                                                                        • Optionalcallback: (error: Error) => void

                                                                                          Callback for when this chunk of data is flushed.

                                                                                          +

                                                                                        Returns boolean

                                                                                        false if the stream wishes for the calling code to wait for the 'drain' event to be emitted before continuing to write additional data; otherwise true.

                                                                                        +

                                                                                        v0.9.4

                                                                                        +

                                                                                        • Listens once to the abort event on the provided signal.

                                                                                          Listening to the abort event on abort signals is unsafe and may lead to resource leaks since another third party with the signal can call e.stopImmediatePropagation(). Unfortunately Node.js cannot change @@ -467,10 +471,10 @@

                                                                                          Parameters

                                                                                          Returns Disposable

                                                                                          Disposable that removes the abort listener.

                                                                                          -

                                                                                          v20.5.0

                                                                                          -

                                                                                        • A utility method for creating a Writable from a web WritableStream.

                                                                                          -

                                                                                          Parameters

                                                                                          • writableStream: WritableStream
                                                                                          • Optionaloptions: Pick<
                                                                                                WritableOptions,
                                                                                                "decodeStrings"
                                                                                                | "highWaterMark"
                                                                                                | "objectMode"
                                                                                                | "signal",
                                                                                            >

                                                                                          Returns Writable

                                                                                          v17.0.0

                                                                                          -

                                                                                        • Returns a copy of the array of listeners for the event named eventName.

                                                                                          +

                                                                                          v20.5.0

                                                                                          +

                                                                                        • A utility method for creating a Writable from a web WritableStream.

                                                                                          +

                                                                                          Parameters

                                                                                          • writableStream: WritableStream
                                                                                          • Optionaloptions: Pick<
                                                                                                WritableOptions,
                                                                                                "decodeStrings"
                                                                                                | "highWaterMark"
                                                                                                | "objectMode"
                                                                                                | "signal",
                                                                                            >

                                                                                          Returns Writable

                                                                                          v17.0.0

                                                                                          +

                                                                                        • Returns a copy of the array of listeners for the event named eventName.

                                                                                          For EventEmitters this behaves exactly the same as calling .listeners on the emitter.

                                                                                          For EventTargets this is the only way to get the event listeners for the @@ -478,8 +482,8 @@ 

                                                                                          import { getEventListeners, EventEmitter } from 'node:events';

                                                                                          {
                                                                                            const ee = new EventEmitter();
                                                                                            const listener = () => console.log('Events are fun');
                                                                                            ee.on('foo', listener);
                                                                                            console.log(getEventListeners(ee, 'foo')); // [ [Function: listener] ]
                                                                                          }
                                                                                          {
                                                                                            const et = new EventTarget();
                                                                                            const listener = () => console.log('Events are fun');
                                                                                            et.addEventListener('foo', listener);
                                                                                            console.log(getEventListeners(et, 'foo')); // [ [Function: listener] ]
                                                                                          }
                                                                                          -

                                                                                          Parameters

                                                                                          Returns Function[]

                                                                                          v15.2.0, v14.17.0

                                                                                          -

                                                                                        • Returns the currently set max amount of listeners.

                                                                                          For EventEmitters this behaves exactly the same as calling .getMaxListeners on the emitter.

                                                                                          For EventTargets this is the only way to get the max event listeners for the @@ -488,16 +492,16 @@ 

                                                                                          import { getMaxListeners, setMaxListeners, EventEmitter } from 'node:events';

                                                                                          {
                                                                                            const ee = new EventEmitter();
                                                                                            console.log(getMaxListeners(ee)); // 10
                                                                                            setMaxListeners(11, ee);
                                                                                            console.log(getMaxListeners(ee)); // 11
                                                                                          }
                                                                                          {
                                                                                            const et = new EventTarget();
                                                                                            console.log(getMaxListeners(et)); // 10
                                                                                            setMaxListeners(11, et);
                                                                                            console.log(getMaxListeners(et)); // 11
                                                                                          }
                                                                                          -

                                                                                          Parameters

                                                                                          Returns number

                                                                                          v19.9.0

                                                                                          -

                                                                                        • A class method that returns the number of listeners for the given eventName registered on the given emitter.

                                                                                          +

                                                                                          Parameters

                                                                                          Returns number

                                                                                          v19.9.0

                                                                                          +

                                                                                        • A class method that returns the number of listeners for the given eventName registered on the given emitter.

                                                                                          import { EventEmitter, listenerCount } from 'node:events';

                                                                                          const myEmitter = new EventEmitter();
                                                                                          myEmitter.on('event', () => {});
                                                                                          myEmitter.on('event', () => {});
                                                                                          console.log(listenerCount(myEmitter, 'event'));
                                                                                          // Prints: 2

                                                                                          Parameters

                                                                                          • emitter: EventEmitter

                                                                                            The emitter to query

                                                                                            -
                                                                                          • eventName: string | symbol

                                                                                            The event name

                                                                                            -

                                                                                          Returns number

                                                                                          v0.9.12

                                                                                          +
                                                                                        • eventName: string | symbol

                                                                                          The event name

                                                                                          +

                                                                                        Returns number

                                                                                        v0.9.12

                                                                                        Since v3.2.0 - Use listenerCount instead.

                                                                                        -
                                                                                        • import { on, EventEmitter } from 'node:events';
                                                                                          import process from 'node:process';

                                                                                          const ee = new EventEmitter();

                                                                                          // Emit later on
                                                                                          process.nextTick(() => {
                                                                                            ee.emit('foo', 'bar');
                                                                                            ee.emit('foo', 42);
                                                                                          });

                                                                                          for await (const event of on(ee, 'foo')) {
                                                                                            // The execution of this inner block is synchronous and it
                                                                                            // processes one event at a time (even with await). Do not use
                                                                                            // if concurrent execution is required.
                                                                                            console.log(event); // prints ['bar'] [42]
                                                                                          }
                                                                                          // Unreachable here
+
                                                                                        • import { on, EventEmitter } from 'node:events';
                                                                                          import process from 'node:process';

                                                                                          const ee = new EventEmitter();

                                                                                          // Emit later on
                                                                                          process.nextTick(() => {
                                                                                            ee.emit('foo', 'bar');
                                                                                            ee.emit('foo', 42);
                                                                                          });

                                                                                          for await (const event of on(ee, 'foo')) {
                                                                                            // The execution of this inner block is synchronous and it
                                                                                            // processes one event at a time (even with await). Do not use
                                                                                            // if concurrent execution is required.
                                                                                            console.log(event); // prints ['bar'] [42]
                                                                                          }
                                                                                          // Unreachable here

                                                                                          Returns an AsyncIterator that iterates eventName events. It will throw @@ -513,8 +517,8 @@

                                                                                          Parameters

                                                                                          Returns AsyncIterator<any[]>

                                                                                          An AsyncIterator that iterates eventName events emitted by the emitter

                                                                                          -

                                                                                          v13.6.0, v12.16.0

                                                                                          -
                                                                                        • import { on, EventEmitter } from 'node:events';
                                                                                          import process from 'node:process';

                                                                                          const ee = new EventEmitter();

                                                                                          // Emit later on
                                                                                          process.nextTick(() => {
                                                                                            ee.emit('foo', 'bar');
                                                                                            ee.emit('foo', 42);
                                                                                          });

                                                                                          for await (const event of on(ee, 'foo')) {
                                                                                            // The execution of this inner block is synchronous and it
                                                                                            // processes one event at a time (even with await). Do not use
                                                                                            // if concurrent execution is required.
                                                                                            console.log(event); // prints ['bar'] [42]
                                                                                          }
                                                                                          // Unreachable here
+
                                                                                          v13.6.0, v12.16.0
                                                                                          
+
                                                                                        • import { on, EventEmitter } from 'node:events';
                                                                                          import process from 'node:process';

                                                                                          const ee = new EventEmitter();

                                                                                          // Emit later on
                                                                                          process.nextTick(() => {
                                                                                            ee.emit('foo', 'bar');
                                                                                            ee.emit('foo', 42);
                                                                                          });

                                                                                          for await (const event of on(ee, 'foo')) {
                                                                                            // The execution of this inner block is synchronous and it
                                                                                            // processes one event at a time (even with await). Do not use
                                                                                            // if concurrent execution is required.
                                                                                            console.log(event); // prints ['bar'] [42]
                                                                                          }
                                                                                          // Unreachable here

                                                                                          Returns an AsyncIterator that iterates eventName events. It will throw @@ -530,8 +534,8 @@

                                                                                          Parameters

                                                                                          Returns AsyncIterator<any[]>

                                                                                          An AsyncIterator that iterates eventName events emitted by the emitter

                                                                                          -

                                                                                          v13.6.0, v12.16.0

                                                                                          -

                                                                                        • Creates a Promise that is fulfilled when the EventEmitter emits the given +

                                                                                          v13.6.0, v12.16.0

                                                                                          +

                                                                                        • Creates a Promise that is fulfilled when the EventEmitter emits the given event or that is rejected if the EventEmitter emits 'error' while waiting. The Promise will resolve with an array of all the arguments emitted to the given event.

                                                                                          @@ -550,8 +554,8 @@ 
                                                                                          import { EventEmitter, once } from 'node:events';

                                                                                          const ee = new EventEmitter();
                                                                                          const ac = new AbortController();

                                                                                          async function foo(emitter, event, signal) {
                                                                                            try {
                                                                                              await once(emitter, event, { signal });
                                                                                              console.log('event emitted!');
                                                                                            } catch (error) {
                                                                                              if (error.name === 'AbortError') {
                                                                                                console.error('Waiting for the event was canceled!');
                                                                                              } else {
                                                                                                console.error('There was an error', error.message);
                                                                                              }
                                                                                            }
                                                                                          }

                                                                                          foo(ee, 'foo', ac.signal);
                                                                                          ac.abort(); // Abort waiting for the event
                                                                                          ee.emit('foo'); // Prints: Waiting for the event was canceled!
                                                                                          -

                                                                                          Parameters

                                                                                          Returns Promise<any[]>

                                                                                          v11.13.0, v10.16.0

                                                                                          -

                                                                                        • Creates a Promise that is fulfilled when the EventEmitter emits the given +

                                                                                          Parameters

                                                                                          Returns Promise<any[]>

                                                                                          v11.13.0, v10.16.0

                                                                                          +

                                                                                        • Creates a Promise that is fulfilled when the EventEmitter emits the given event or that is rejected if the EventEmitter emits 'error' while waiting. The Promise will resolve with an array of all the arguments emitted to the given event.

                                                                                          @@ -570,14 +574,14 @@ 
                                                                                          import { EventEmitter, once } from 'node:events';

                                                                                          const ee = new EventEmitter();
                                                                                          const ac = new AbortController();

                                                                                          async function foo(emitter, event, signal) {
                                                                                            try {
                                                                                              await once(emitter, event, { signal });
                                                                                              console.log('event emitted!');
                                                                                            } catch (error) {
                                                                                              if (error.name === 'AbortError') {
                                                                                                console.error('Waiting for the event was canceled!');
                                                                                              } else {
                                                                                                console.error('There was an error', error.message);
                                                                                              }
                                                                                            }
                                                                                          }

                                                                                          foo(ee, 'foo', ac.signal);
                                                                                          ac.abort(); // Abort waiting for the event
                                                                                          ee.emit('foo'); // Prints: Waiting for the event was canceled!
                                                                                          -

                                                                                          Parameters

                                                                                          Returns Promise<any[]>

                                                                                          v11.13.0, v10.16.0

                                                                                          -
                                                                                        • import { setMaxListeners, EventEmitter } from 'node:events';

                                                                                          const target = new EventTarget();
                                                                                          const emitter = new EventEmitter();

                                                                                          setMaxListeners(5, target, emitter);
+

                                                                                          Parameters

                                                                                          Returns Promise<any[]>

                                                                                          v11.13.0, v10.16.0

                                                                                          +
                                                                                        • import { setMaxListeners, EventEmitter } from 'node:events';

                                                                                          const target = new EventTarget();
                                                                                          const emitter = new EventEmitter();

                                                                                          setMaxListeners(5, target, emitter);

                                                                                          Parameters

                                                                                          • Optionaln: number

                                                                                            A non-negative number. The maximum number of listeners per EventTarget event.

                                                                                            -
                                                                                          • ...eventTargets: (EventEmitter<DefaultEventMap> | EventTarget)[]

                                                                                            Zero or more {EventTarget} or {EventEmitter} instances. If none are specified, n is set as the default max for all newly created {EventTarget} and {EventEmitter} +

                                                                                          • ...eventTargets: (EventEmitter<DefaultEventMap> | EventTarget)[]

                                                                                            Zero or more {EventTarget} or {EventEmitter} instances. If none are specified, n is set as the default max for all newly created {EventTarget} and {EventEmitter} objects.

                                                                                            -

                                                                                          Returns void

                                                                                          v15.4.0

                                                                                          -

                                                                                        • A utility method for creating a web WritableStream from a Writable.

                                                                                          -

                                                                                          Parameters

                                                                                          Returns WritableStream

                                                                                          v17.0.0

                                                                                          -

                                                                                        Settings

                                                                                        Member Visibility

                                                                                        On This Page

                                                                                        Constructors
                                                                                        Properties
                                                                                        Methods
                                                                                        +

                                                                                        Returns void

                                                                                        v15.4.0

                                                                                        +

                                                                                        • A utility method for creating a web WritableStream from a Writable.

                                                                                          +

                                                                                          Parameters

                                                                                          Returns WritableStream

                                                                                          v17.0.0

                                                                                          +

                                                                                        Settings

                                                                                        Member Visibility

                                                                                        On This Page

                                                                                        Constructors
                                                                                        Properties
                                                                                        Methods
                                                                                        diff --git a/docs/classes/_internal_.Stream.html b/docs/classes/_internal_.Stream.html index 1b7e17c2..df10cc11 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 @@ -36,13 +36,13 @@ on once setMaxListeners -

                                                                                        Constructors

                                                                                        Properties

                                                                                        captureRejections: boolean

                                                                                        Value: boolean

                                                                                        +

                                                                                        Constructors

                                                                                        Properties

                                                                                        captureRejections: boolean

                                                                                        Value: boolean

                                                                                        Change the default captureRejections option on all new EventEmitter objects.

                                                                                        v13.4.0, v12.16.0

                                                                                        -
                                                                                        captureRejectionSymbol: typeof captureRejectionSymbol

                                                                                        Value: Symbol.for('nodejs.rejection')

                                                                                        +
                                                                                        captureRejectionSymbol: typeof captureRejectionSymbol

                                                                                        Value: Symbol.for('nodejs.rejection')

                                                                                        See how to write a custom rejection handler.

                                                                                        v13.4.0, v12.16.0

                                                                                        -
                                                                                        defaultMaxListeners: number

                                                                                        By default, a maximum of 10 listeners can be registered for any single +

                                                                                        defaultMaxListeners: number

                                                                                        By default, a maximum of 10 listeners can be registered for any single event. This limit can be changed for individual EventEmitter instances using the emitter.setMaxListeners(n) method. To change the default for allEventEmitter instances, the events.defaultMaxListeners property @@ -67,42 +67,42 @@ listeners, respectively. Its name property is set to 'MaxListenersExceededWarning'.

                                                                                        v0.11.2

                                                                                        -
                                                                                        errorMonitor: typeof errorMonitor

                                                                                        This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

                                                                                        +
                                                                                        errorMonitor: typeof errorMonitor

                                                                                        This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

                                                                                        Installing a listener using this symbol does not change the behavior once an 'error' event is emitted. Therefore, the process will still crash if no regular 'error' listener is installed.

                                                                                        v13.6.0, v12.17.0

                                                                                        -

                                                                                        Methods

                                                                                        • Type Parameters

                                                                                          • K

                                                                                          Parameters

                                                                                          • error: Error
                                                                                          • event: string | symbol
                                                                                          • ...args: AnyRest

                                                                                          Returns void

                                                                                        • Alias for emitter.on(eventName, listener).

                                                                                          +

                                                                                        Methods

                                                                                        • Type Parameters

                                                                                          • K

                                                                                          Parameters

                                                                                          • error: Error
                                                                                          • event: string | symbol
                                                                                          • ...args: AnyRest

                                                                                          Returns void

                                                                                        • Alias for emitter.on(eventName, listener).

                                                                                          Type Parameters

                                                                                          • K

                                                                                          Parameters

                                                                                          • eventName: string | symbol
                                                                                          • listener: (...args: any[]) => void

                                                                                          Returns this

                                                                                          v0.1.26

                                                                                          -

                                                                                        • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments +

                                                                                        • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

                                                                                          Returns true if the event had listeners, false otherwise.

                                                                                          import { EventEmitter } from 'node:events';
                                                                                          const myEmitter = new EventEmitter();

                                                                                          // First listener
                                                                                          myEmitter.on('event', function firstListener() {
                                                                                            console.log('Helloooo! first listener');
                                                                                          });
                                                                                          // Second listener
                                                                                          myEmitter.on('event', function secondListener(arg1, arg2) {
                                                                                            console.log(`event with parameters ${arg1}, ${arg2} in second listener`);
                                                                                          });
                                                                                          // Third listener
                                                                                          myEmitter.on('event', function thirdListener(...args) {
                                                                                            const parameters = args.join(', ');
                                                                                            console.log(`event with parameters ${parameters} in third listener`);
                                                                                          });

                                                                                          console.log(myEmitter.listeners('event'));

                                                                                          myEmitter.emit('event', 1, 2, 3, 4, 5);

                                                                                          // Prints:
                                                                                          // [
                                                                                          //   [Function: firstListener],
                                                                                          //   [Function: secondListener],
                                                                                          //   [Function: thirdListener]
                                                                                          // ]
                                                                                          // Helloooo! first listener
                                                                                          // event with parameters 1, 2 in second listener
                                                                                          // event with parameters 1, 2, 3, 4, 5 in third listener

                                                                                          Type Parameters

                                                                                          • K

                                                                                          Parameters

                                                                                          • eventName: string | symbol
                                                                                          • ...args: AnyRest

                                                                                          Returns boolean

                                                                                          v0.1.26

                                                                                          -

                                                                                        • Returns an array listing the events for which the emitter has registered +

                                                                                        • Returns an array listing the events for which the emitter has registered listeners. The values in the array are strings or Symbols.

                                                                                          import { EventEmitter } from 'node:events';

                                                                                          const myEE = new EventEmitter();
                                                                                          myEE.on('foo', () => {});
                                                                                          myEE.on('bar', () => {});

                                                                                          const sym = Symbol('symbol');
                                                                                          myEE.on(sym, () => {});

                                                                                          console.log(myEE.eventNames());
                                                                                          // Prints: [ 'foo', 'bar', Symbol(symbol) ]

                                                                                          Returns (string | symbol)[]

                                                                                          v6.0.0

                                                                                          -

                                                                                        • Returns the current max listener value for the EventEmitter which is either +

                                                                                        • Returns the current max listener value for the EventEmitter which is either set by emitter.setMaxListeners(n) or defaults to EventEmitter.defaultMaxListeners.

                                                                                          Returns number

                                                                                          v1.0.0

                                                                                          -

                                                                                        • Returns the number of listeners listening for the event named eventName. +

                                                                                        • Returns the number of listeners listening for the event named eventName. If listener is provided, it will return how many times the listener is found in the list of the listeners of the event.

                                                                                          Type Parameters

                                                                                          • K

                                                                                          Parameters

                                                                                          • eventName: string | symbol

                                                                                            The name of the event being listened for

                                                                                            -
                                                                                          • Optionallistener: Function

                                                                                            The event handler function

                                                                                            -

                                                                                          Returns number

                                                                                          v3.2.0

                                                                                          -

                                                                                        • Returns a copy of the array of listeners for the event named eventName.

                                                                                          +
                                                                                        • Optionallistener: Function

                                                                                          The event handler function

                                                                                          +

                                                                                        Returns number

                                                                                        v3.2.0

                                                                                        +

                                                                                        • Returns a copy of the array of listeners for the event named eventName.

                                                                                          server.on('connection', (stream) => {
                                                                                            console.log('someone connected!');
                                                                                          });
                                                                                          console.log(util.inspect(server.listeners('connection')));
                                                                                          // Prints: [ [Function] ]

                                                                                          Type Parameters

                                                                                          • K

                                                                                          Parameters

                                                                                          • eventName: string | symbol

                                                                                          Returns Function[]

                                                                                          v0.1.26

                                                                                          -

                                                                                        • Alias for emitter.removeListener().

                                                                                          +

                                                                                        • Alias for emitter.removeListener().

                                                                                          Type Parameters

                                                                                          • K

                                                                                          Parameters

                                                                                          • eventName: string | symbol
                                                                                          • listener: (...args: any[]) => void

                                                                                          Returns this

                                                                                          v10.0.0

                                                                                          -

                                                                                        • Adds the listener function to the end of the listeners array for the event +

                                                                                        • Adds the listener function to the end of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.

                                                                                          @@ -116,9 +116,9 @@

                                                                                          Type Parameters

                                                                                          • K

                                                                                          Parameters

                                                                                          • eventName: string | symbol

                                                                                            The name of the event.

                                                                                            -
                                                                                          • listener: (...args: any[]) => void

                                                                                            The callback function

                                                                                            -

                                                                                          Returns this

                                                                                          v0.1.101

                                                                                          -

                                                                                        • Adds a one-time listener function for the event named eventName. The +

                                                                                        • listener: (...args: any[]) => void

                                                                                          The callback function

                                                                                          +

                                                                                        Returns this

                                                                                        v0.1.101

                                                                                        +

                                                                                        • Adds a one-time listener function for the event named eventName. The next time eventName is triggered, this listener is removed and then invoked.

                                                                                          server.once('connection', (stream) => {
                                                                                            console.log('Ah, we have our first user!');
                                                                                          });
                                                                                          @@ -130,9 +130,9 @@

                                                                                          Type Parameters

                                                                                          • K

                                                                                          Parameters

                                                                                          • eventName: string | symbol

                                                                                            The name of the event.

                                                                                            -
                                                                                          • listener: (...args: any[]) => void

                                                                                            The callback function

                                                                                            -

                                                                                          Returns this

                                                                                          v0.3.0

                                                                                          -

                                                                                        • Type Parameters

                                                                                          Parameters

                                                                                          • destination: T
                                                                                          • Optionaloptions: { end?: boolean }

                                                                                          Returns T

                                                                                        • Adds the listener function to the beginning of the listeners array for the +

                                                                                        • listener: (...args: any[]) => void

                                                                                          The callback function

                                                                                          +

                                                                                        Returns this

                                                                                        v0.3.0

                                                                                        +

                                                                                        • Type Parameters

                                                                                          Parameters

                                                                                          • destination: T
                                                                                          • Optionaloptions: { end?: boolean }

                                                                                          Returns T

                                                                                        • Adds the listener function to the beginning of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.

                                                                                          @@ -141,30 +141,30 @@

                                                                                          Returns a reference to the EventEmitter, so that calls can be chained.

                                                                                          Type Parameters

                                                                                          • K

                                                                                          Parameters

                                                                                          • eventName: string | symbol

                                                                                            The name of the event.

                                                                                            -
                                                                                          • listener: (...args: any[]) => void

                                                                                            The callback function

                                                                                            -

                                                                                          Returns this

                                                                                          v6.0.0

                                                                                          -

                                                                                        • Adds a one-timelistener function for the event named eventName to the beginning of the listeners array. The next time eventName is triggered, this +

                                                                                        • listener: (...args: any[]) => void

                                                                                          The callback function

                                                                                          +

                                                                                        Returns this

                                                                                        v6.0.0

                                                                                        +

                                                                                        • Adds a one-timelistener function for the event named eventName to the beginning of the listeners array. The next time eventName is triggered, this listener is removed, and then invoked.

                                                                                          server.prependOnceListener('connection', (stream) => {
                                                                                            console.log('Ah, we have our first user!');
                                                                                          });

                                                                                          Returns a reference to the EventEmitter, so that calls can be chained.

                                                                                          Type Parameters

                                                                                          • K

                                                                                          Parameters

                                                                                          • eventName: string | symbol

                                                                                            The name of the event.

                                                                                            -
                                                                                          • listener: (...args: any[]) => void

                                                                                            The callback function

                                                                                            -

                                                                                          Returns this

                                                                                          v6.0.0

                                                                                          -

                                                                                        • Returns a copy of the array of listeners for the event named eventName, +

                                                                                        • listener: (...args: any[]) => void

                                                                                          The callback function

                                                                                          +

                                                                                        Returns this

                                                                                        v6.0.0

                                                                                        +

                                                                                        • Returns a copy of the array of listeners for the event named eventName, including any wrappers (such as those created by .once()).

                                                                                          import { EventEmitter } from 'node:events';
                                                                                          const emitter = new EventEmitter();
                                                                                          emitter.once('log', () => console.log('log once'));

                                                                                          // Returns a new Array with a function `onceWrapper` which has a property
                                                                                          // `listener` which contains the original listener bound above
                                                                                          const listeners = emitter.rawListeners('log');
                                                                                          const logFnWrapper = listeners[0];

                                                                                          // Logs "log once" to the console and does not unbind the `once` event
                                                                                          logFnWrapper.listener();

                                                                                          // Logs "log once" to the console and removes the listener
                                                                                          logFnWrapper();

                                                                                          emitter.on('log', () => console.log('log persistently'));
                                                                                          // Will return a new Array with a single function bound by `.on()` above
                                                                                          const newListeners = emitter.rawListeners('log');

                                                                                          // Logs "log persistently" twice
                                                                                          newListeners[0]();
                                                                                          emitter.emit('log');

                                                                                          Type Parameters

                                                                                          • K

                                                                                          Parameters

                                                                                          • eventName: string | symbol

                                                                                          Returns Function[]

                                                                                          v9.4.0

                                                                                          -

                                                                                        • Removes all listeners, or those of the specified eventName.

                                                                                          +

                                                                                        • Removes all listeners, or those of the specified eventName.

                                                                                          It is bad practice to remove listeners added elsewhere in the code, particularly when the EventEmitter instance was created by some other component or module (e.g. sockets or file streams).

                                                                                          Returns a reference to the EventEmitter, so that calls can be chained.

                                                                                          Parameters

                                                                                          • OptionaleventName: string | symbol

                                                                                          Returns this

                                                                                          v0.1.26

                                                                                          -

                                                                                        • Removes the specified listener from the listener array for the event named eventName.

                                                                                          +

                                                                                        • Removes the specified listener from the listener array for the event named eventName.

                                                                                          const callback = (stream) => {
                                                                                            console.log('someone connected!');
                                                                                          };
                                                                                          server.on('connection', callback);
                                                                                          // ...
                                                                                          server.removeListener('connection', callback);
                                                                                          @@ -191,13 +191,13 @@

                                                                                          Returns a reference to the EventEmitter, so that calls can be chained.

                                                                                          Type Parameters

                                                                                          • K

                                                                                          Parameters

                                                                                          • eventName: string | symbol
                                                                                          • listener: (...args: any[]) => void

                                                                                          Returns this

                                                                                          v0.1.26

                                                                                          -

                                                                                        • By default EventEmitters will print a warning if more than 10 listeners are +

                                                                                        • By default EventEmitters will print a warning if more than 10 listeners are added for a particular event. This is a useful default that helps finding memory leaks. The emitter.setMaxListeners() method allows the limit to be modified for this specific EventEmitter instance. The value can be set to Infinity (or 0) to indicate an unlimited number of listeners.

                                                                                          Returns a reference to the EventEmitter, so that calls can be chained.

                                                                                          Parameters

                                                                                          • n: number

                                                                                          Returns this

                                                                                          v0.3.5

                                                                                          -

                                                                                        • Listens once to the abort event on the provided signal.

                                                                                          +

                                                                                        • Listens once to the abort event on the provided signal.

                                                                                          Listening to the abort event on abort signals is unsafe and may lead to resource leaks since another third party with the signal can call e.stopImmediatePropagation(). Unfortunately Node.js cannot change @@ -212,7 +212,7 @@

                                                                                          Parameters

                                                                                          Returns Disposable

                                                                                          Disposable that removes the abort listener.

                                                                                          v20.5.0

                                                                                          -

                                                                                        • Returns a copy of the array of listeners for the event named eventName.

                                                                                          For EventEmitters this behaves exactly the same as calling .listeners on the emitter.

                                                                                          For EventTargets this is the only way to get the event listeners for the @@ -221,7 +221,7 @@

                                                                                          Parameters

                                                                                          Returns Function[]

                                                                                          v15.2.0, v14.17.0

                                                                                          -

                                                                                        • A class method that returns the number of listeners for the given eventName registered on the given emitter.

                                                                                          +

                                                                                        • A class method that returns the number of listeners for the given eventName registered on the given emitter.

                                                                                          import { EventEmitter, listenerCount } from 'node:events';

                                                                                          const myEmitter = new EventEmitter();
                                                                                          myEmitter.on('event', () => {});
                                                                                          myEmitter.on('event', () => {});
                                                                                          console.log(listenerCount(myEmitter, 'event'));
                                                                                          // Prints: 2

                                                                                          Parameters

                                                                                          • emitter: EventEmitter

                                                                                            The emitter to query

                                                                                            -
                                                                                          • eventName: string | symbol

                                                                                            The event name

                                                                                            -

                                                                                          Returns number

                                                                                          v0.9.12

                                                                                          +
                                                                                        • eventName: string | symbol

                                                                                          The event name

                                                                                          +

                                                                                        Returns number

                                                                                        v0.9.12

                                                                                        Since v3.2.0 - Use listenerCount instead.

                                                                                        -
                                                                                        • import { on, EventEmitter } from 'node:events';
                                                                                          import process from 'node:process';

                                                                                          const ee = new EventEmitter();

                                                                                          // Emit later on
                                                                                          process.nextTick(() => {
                                                                                            ee.emit('foo', 'bar');
                                                                                            ee.emit('foo', 42);
                                                                                          });

                                                                                          for await (const event of on(ee, 'foo')) {
                                                                                            // The execution of this inner block is synchronous and it
                                                                                            // processes one event at a time (even with await). Do not use
                                                                                            // if concurrent execution is required.
                                                                                            console.log(event); // prints ['bar'] [42]
                                                                                          }
                                                                                          // Unreachable here
+
                                                                                        • import { on, EventEmitter } from 'node:events';
                                                                                          import process from 'node:process';

                                                                                          const ee = new EventEmitter();

                                                                                          // Emit later on
                                                                                          process.nextTick(() => {
                                                                                            ee.emit('foo', 'bar');
                                                                                            ee.emit('foo', 42);
                                                                                          });

                                                                                          for await (const event of on(ee, 'foo')) {
                                                                                            // The execution of this inner block is synchronous and it
                                                                                            // processes one event at a time (even with await). Do not use
                                                                                            // if concurrent execution is required.
                                                                                            console.log(event); // prints ['bar'] [42]
                                                                                          }
                                                                                          // Unreachable here

                                                                                          Returns an AsyncIterator that iterates eventName events. It will throw @@ -256,7 +256,7 @@

                                                                                          Parameters

                                                                                          Returns AsyncIterator<any[]>

                                                                                          An AsyncIterator that iterates eventName events emitted by the emitter

                                                                                          v13.6.0, v12.16.0

                                                                                          -
                                                                                        • import { on, EventEmitter } from 'node:events';
                                                                                          import process from 'node:process';

                                                                                          const ee = new EventEmitter();

                                                                                          // Emit later on
                                                                                          process.nextTick(() => {
                                                                                            ee.emit('foo', 'bar');
                                                                                            ee.emit('foo', 42);
                                                                                          });

                                                                                          for await (const event of on(ee, 'foo')) {
                                                                                            // The execution of this inner block is synchronous and it
                                                                                            // processes one event at a time (even with await). Do not use
                                                                                            // if concurrent execution is required.
                                                                                            console.log(event); // prints ['bar'] [42]
                                                                                          }
                                                                                          // Unreachable here
+
                                                                                        • import { on, EventEmitter } from 'node:events';
                                                                                          import process from 'node:process';

                                                                                          const ee = new EventEmitter();

                                                                                          // Emit later on
                                                                                          process.nextTick(() => {
                                                                                            ee.emit('foo', 'bar');
                                                                                            ee.emit('foo', 42);
                                                                                          });

                                                                                          for await (const event of on(ee, 'foo')) {
                                                                                            // The execution of this inner block is synchronous and it
                                                                                            // processes one event at a time (even with await). Do not use
                                                                                            // if concurrent execution is required.
                                                                                            console.log(event); // prints ['bar'] [42]
                                                                                          }
                                                                                          // Unreachable here

                                                                                          Returns an AsyncIterator that iterates eventName events. It will throw @@ -273,7 +273,7 @@

                                                                                          Parameters

                                                                                          Returns AsyncIterator<any[]>

                                                                                          An AsyncIterator that iterates eventName events emitted by the emitter

                                                                                          v13.6.0, v12.16.0

                                                                                          -

                                                                                        • Creates a Promise that is fulfilled when the EventEmitter emits the given +

                                                                                        • Creates a Promise that is fulfilled when the EventEmitter emits the given event or that is rejected if the EventEmitter emits 'error' while waiting. The Promise will resolve with an array of all the arguments emitted to the given event.

                                                                                          @@ -293,7 +293,7 @@

                                                                                          Parameters

                                                                                          Returns Promise<any[]>

                                                                                          v11.13.0, v10.16.0

                                                                                          -

                                                                                        • Creates a Promise that is fulfilled when the EventEmitter emits the given +

                                                                                        • Creates a Promise that is fulfilled when the EventEmitter emits the given event or that is rejected if the EventEmitter emits 'error' while waiting. The Promise will resolve with an array of all the arguments emitted to the given event.

                                                                                          @@ -313,11 +313,11 @@

                                                                                          Parameters

                                                                                          Returns Promise<any[]>

                                                                                          v11.13.0, v10.16.0

                                                                                          -
                                                                                        • import { setMaxListeners, EventEmitter } from 'node:events';

                                                                                          const target = new EventTarget();
                                                                                          const emitter = new EventEmitter();

                                                                                          setMaxListeners(5, target, emitter);
+
                                                                                        • import { setMaxListeners, EventEmitter } from 'node:events';

                                                                                          const target = new EventTarget();
                                                                                          const emitter = new EventEmitter();

                                                                                          setMaxListeners(5, target, emitter);

                                                                                          Parameters

                                                                                          • Optionaln: number

                                                                                            A non-negative number. The maximum number of listeners per EventTarget event.

                                                                                            -
                                                                                          • ...eventTargets: (EventEmitter<DefaultEventMap> | EventTarget)[]

                                                                                            Zero or more {EventTarget} or {EventEmitter} instances. If none are specified, n is set as the default max for all newly created {EventTarget} and {EventEmitter} +

                                                                                          • ...eventTargets: (EventEmitter<DefaultEventMap> | EventTarget)[]

                                                                                            Zero or more {EventTarget} or {EventEmitter} instances. If none are specified, n is set as the default max for all newly created {EventTarget} and {EventEmitter} objects.

                                                                                            -

                                                                                          Returns void

                                                                                          v15.4.0

                                                                                          -

                                                                                        Settings

                                                                                        Member Visibility

                                                                                        On This Page

                                                                                        Constructors
                                                                                        Properties
                                                                                        Methods
                                                                                        +

                                                                                        Returns void

                                                                                        v15.4.0

                                                                                        +

                                                                                        Settings

                                                                                        Member Visibility

                                                                                        On This Page

                                                                                        Constructors
                                                                                        Properties
                                                                                        Methods
                                                                                        diff --git a/docs/classes/_internal_.URL.html b/docs/classes/_internal_.URL.html index ffde5086..122d6b90 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 @@ -26,25 +26,25 @@ createObjectURL parse revokeObjectURL -

                                                                                        Constructors

                                                                                        • Parameters

                                                                                          • input: string | { toString: () => string }
                                                                                          • Optionalbase: string | URL

                                                                                          Returns URL

                                                                                        Properties

                                                                                        hash: string

                                                                                        Gets and sets the fragment portion of the URL.

                                                                                        +

                                                                                        Constructors

                                                                                        • Parameters

                                                                                          • input: string | { toString: () => string }
                                                                                          • Optionalbase: string | URL

                                                                                          Returns URL

                                                                                        Properties

                                                                                        hash: string

                                                                                        Gets and sets the fragment portion of the URL.

                                                                                        const myURL = new URL('https://example.org/foo#bar');
                                                                                        console.log(myURL.hash);
                                                                                        // Prints #bar

                                                                                        myURL.hash = 'baz';
                                                                                        console.log(myURL.href);
                                                                                        // Prints https://example.org/foo#baz

                                                                                        Invalid URL characters included in the value assigned to the hash property are percent-encoded. The selection of which characters to percent-encode may vary somewhat from what the parse and format methods would produce.

                                                                                        -
                                                                                        host: string

                                                                                        Gets and sets the host portion of the URL.

                                                                                        +
                                                                                        host: string

                                                                                        Gets and sets the host portion of the URL.

                                                                                        const myURL = new URL('https://example.org:81/foo');
                                                                                        console.log(myURL.host);
                                                                                        // Prints example.org:81

                                                                                        myURL.host = 'example.com:82';
                                                                                        console.log(myURL.href);
                                                                                        // Prints https://example.com:82/foo

                                                                                        Invalid host values assigned to the host property are ignored.

                                                                                        -
                                                                                        hostname: string

                                                                                        Gets and sets the host name portion of the URL. The key difference betweenurl.host and url.hostname is that url.hostname does not include the +

                                                                                        hostname: string

                                                                                        Gets and sets the host name portion of the URL. The key difference betweenurl.host and url.hostname is that url.hostname does not include the port.

                                                                                        const myURL = new URL('https://example.org:81/foo');
                                                                                        console.log(myURL.hostname);
                                                                                        // Prints example.org

                                                                                        // Setting the hostname does not change the port
                                                                                        myURL.hostname = 'example.com';
                                                                                        console.log(myURL.href);
                                                                                        // Prints https://example.com:81/foo

                                                                                        // Use myURL.host to change the hostname and port
                                                                                        myURL.host = 'example.org:82';
                                                                                        console.log(myURL.href);
                                                                                        // Prints https://example.org:82/foo

                                                                                        Invalid host name values assigned to the hostname property are ignored.

                                                                                        -
                                                                                        href: string

                                                                                        Gets and sets the serialized URL.

                                                                                        +
                                                                                        href: string

                                                                                        Gets and sets the serialized URL.

                                                                                        const myURL = new URL('https://example.org/foo');
                                                                                        console.log(myURL.href);
                                                                                        // Prints https://example.org/foo

                                                                                        myURL.href = 'https://example.com/bar';
                                                                                        console.log(myURL.href);
                                                                                        // Prints https://example.com/bar
                                                                                        @@ -52,27 +52,27 @@

                                                                                        Setting the value of this property to a new value is equivalent to creating a new URL object using new URL(value). Each of the URL object's properties will be modified.

                                                                                        If the value assigned to the href property is not a valid URL, a TypeError will be thrown.

                                                                                        -
                                                                                        origin: string

                                                                                        Gets the read-only serialization of the URL's origin.

                                                                                        +
                                                                                        origin: string

                                                                                        Gets the read-only serialization of the URL's origin.

                                                                                        const myURL = new URL('https://example.org/foo/bar?baz');
                                                                                        console.log(myURL.origin);
                                                                                        // Prints https://example.org
 
                                                                                        const idnURL = new URL('https://測試');
                                                                                        console.log(idnURL.origin);
                                                                                        // Prints https://xn--g6w251d

                                                                                        console.log(idnURL.hostname);
                                                                                        // Prints xn--g6w251d
                                                                                        -
                                                                                        password: string

                                                                                        Gets and sets the password portion of the URL.

                                                                                        +
                                                                                        password: string

                                                                                        Gets and sets the password portion of the URL.

                                                                                        const myURL = new URL('https://abc:xyz@example.com');
                                                                                        console.log(myURL.password);
                                                                                        // Prints xyz

                                                                                        myURL.password = '123';
                                                                                        console.log(myURL.href);
                                                                                        // Prints https://abc:123@example.com/

                                                                                        Invalid URL characters included in the value assigned to the password property are percent-encoded. The selection of which characters to percent-encode may vary somewhat from what the parse and format methods would produce.

                                                                                        -
                                                                                        pathname: string

                                                                                        Gets and sets the path portion of the URL.

                                                                                        +
                                                                                        pathname: string

                                                                                        Gets and sets the path portion of the URL.

                                                                                        const myURL = new URL('https://example.org/abc/xyz?123');
                                                                                        console.log(myURL.pathname);
                                                                                        // Prints /abc/xyz

                                                                                        myURL.pathname = '/abcdef';
                                                                                        console.log(myURL.href);
                                                                                        // Prints https://example.org/abcdef?123

                                                                                        Invalid URL characters included in the value assigned to the pathname property are percent-encoded. The selection of which characters to percent-encode may vary somewhat from what the parse and format methods would produce.

                                                                                        -
                                                                                        port: string

                                                                                        Gets and sets the port portion of the URL.

                                                                                        +
                                                                                        port: string

                                                                                        Gets and sets the port portion of the URL.

                                                                                        The port value may be a number or a string containing a number in the range 0 to 65535 (inclusive). Setting the value to the default port of the URL objects given protocol will result in the port value becoming the empty string ('').

                                                                                        @@ -95,18 +95,18 @@ 
                                                                                        myURL.port = 4.567e21;
                                                                                        console.log(myURL.port);
                                                                                        // Prints 4 (because it is the leading number in the string '4.567e21')
                                                                                        -
                                                                                        protocol: string

                                                                                        Gets and sets the protocol portion of the URL.

                                                                                        +
                                                                                        protocol: string

                                                                                        Gets and sets the protocol portion of the URL.

                                                                                        const myURL = new URL('https://example.org');
                                                                                        console.log(myURL.protocol);
                                                                                        // Prints https:

                                                                                        myURL.protocol = 'ftp';
                                                                                        console.log(myURL.href);
                                                                                        // Prints ftp://example.org/

                                                                                        Invalid URL protocol values assigned to the protocol property are ignored.

                                                                                        -
                                                                                        search: string

                                                                                        Gets and sets the serialized query portion of the URL.

                                                                                        +
                                                                                        search: string

                                                                                        Gets and sets the serialized query portion of the URL.

                                                                                        const myURL = new URL('https://example.org/abc?123');
                                                                                        console.log(myURL.search);
                                                                                        // Prints ?123

                                                                                        myURL.search = 'abc=xyz';
                                                                                        console.log(myURL.href);
                                                                                        // Prints https://example.org/abc?abc=xyz

                                                                                        Any invalid URL characters appearing in the value assigned the search property will be percent-encoded. The selection of which characters to percent-encode may vary somewhat from what the parse and format methods would produce.

                                                                                        -
                                                                                        searchParams: URLSearchParams

                                                                                        Gets the URLSearchParams object representing the query parameters of the +

                                                                                        searchParams: URLSearchParams

                                                                                        Gets the URLSearchParams object representing the query parameters of the URL. This property is read-only but the URLSearchParams object it provides can be used to mutate the URL instance; to replace the entirety of query parameters of the URL, use the search setter. See URLSearchParams documentation for details.

                                                                                        @@ -118,30 +118,30 @@ 
                                                                                        const myURL = new URL('https://example.org/abc?foo=~bar');

                                                                                        console.log(myURL.search);  // prints ?foo=~bar

                                                                                        // Modify the URL via searchParams...
                                                                                        myURL.searchParams.sort();

                                                                                        console.log(myURL.search);  // prints ?foo=%7Ebar
                                                                                        -
                                                                                        username: string

                                                                                        Gets and sets the username portion of the URL.

                                                                                        +
                                                                                        username: string

                                                                                        Gets and sets the username portion of the URL.

                                                                                        const myURL = new URL('https://abc:xyz@example.com');
                                                                                        console.log(myURL.username);
                                                                                        // Prints abc

                                                                                        myURL.username = '123';
                                                                                        console.log(myURL.href);
                                                                                        // Prints https://123:xyz@example.com/

                                                                                        Any invalid URL characters appearing in the value assigned the username property will be percent-encoded. The selection of which characters to percent-encode may vary somewhat from what the parse and format methods would produce.

                                                                                        -

                                                                                        Methods

                                                                                        • The toJSON() method on the URL object returns the serialized URL. The +

                                                                                        Methods

                                                                                        • The toJSON() method on the URL object returns the serialized URL. The value returned is equivalent to that of href and toString.

                                                                                          This method is automatically called when an URL object is serialized with JSON.stringify().

                                                                                          const myURLs = [
                                                                                            new URL('https://www.example.com'),
                                                                                            new URL('https://test.example.org'),
                                                                                          ];
                                                                                          console.log(JSON.stringify(myURLs));
                                                                                          // Prints ["https://www.example.com/","https://test.example.org/"]
                                                                                          -

                                                                                          Returns string

                                                                                        • The toString() method on the URL object returns the serialized URL. The +

                                                                                          Returns string

                                                                                        • The toString() method on the URL object returns the serialized URL. The value returned is equivalent to that of href and toJSON.

                                                                                          -

                                                                                          Returns string

                                                                                        • Checks if an input relative to the base can be parsed to a URL.

                                                                                          +

                                                                                          Returns string

                                                                                        • Checks if an input relative to the base can be parsed to a URL.

                                                                                          const isValid = URL.canParse('/foo', 'https://example.org/'); // true

                                                                                          const isNotValid = URL.canParse('/foo'); // false

                                                                                          Parameters

                                                                                          • input: string

                                                                                            The absolute or relative input URL to parse. If input is relative, then base is required. If input is absolute, the base is ignored. If input is not a string, it is converted to a string first.

                                                                                            -
                                                                                          • Optionalbase: string

                                                                                            The base URL to resolve against if the input is not absolute. If base is not a string, it is converted to a string first.

                                                                                            -

                                                                                          Returns boolean

                                                                                          v19.9.0

                                                                                          -

                                                                                        • Creates a 'blob:nodedata:...' URL string that represents the given Blob object and can be used to retrieve the Blob later.

                                                                                          +
                                                                                        • Optionalbase: string

                                                                                          The base URL to resolve against if the input is not absolute. If base is not a string, it is converted to a string first.

                                                                                          +

                                                                                        Returns boolean

                                                                                        v19.9.0

                                                                                        +

                                                                                        • Creates a 'blob:nodedata:...' URL string that represents the given Blob object and can be used to retrieve the Blob later.

                                                                                          import {
                                                                                            Blob,
                                                                                            resolveObjectURL,
                                                                                          } from 'node:buffer';

                                                                                          const blob = new Blob(['hello']);
                                                                                          const id = URL.createObjectURL(blob);

                                                                                          // later...

                                                                                          const otherBlob = resolveObjectURL(id);
                                                                                          console.log(otherBlob.size);
                                                                                          @@ -150,14 +150,17 @@ Threads, Blob objects registered within one Worker will not be available to other workers or the main thread.

                                                                                          Parameters

                                                                                          Returns string

                                                                                          v16.7.0

                                                                                          -

                                                                                        • Parses a string as a URL. If base is provided, it will be used as the base URL for the purpose of resolving non-absolute input URLs. -Returns null if input is not a valid.

                                                                                          -

                                                                                          Parameters

                                                                                          • input: string

                                                                                            The absolute or relative input URL to parse. If input is relative, then base is required. If input is absolute, the base is ignored. If input is not a string, it is -converted to a string first.

                                                                                            -
                                                                                          • Optionalbase: string

                                                                                            The base URL to resolve against if the input is not absolute. If base is not a string, it is converted to a string first.

                                                                                            -

                                                                                          Returns URL

                                                                                          v22.1.0

                                                                                          -

                                                                                        • Removes the stored Blob identified by the given ID. Attempting to revoke a +

                                                                                        • Parses a string as a URL. If base is provided, it will be used as the base +URL for the purpose of resolving non-absolute input URLs. Returns null +if the parameters can't be resolved to a valid URL.

                                                                                          +

                                                                                          Parameters

                                                                                          • input: string

                                                                                            The absolute or relative input URL to parse. If input +is relative, then base is required. If input is absolute, the base +is ignored. If input is not a string, it is converted to a string first.

                                                                                            +
                                                                                          • Optionalbase: string

                                                                                            The base URL to resolve against if the input is not +absolute. If base is not a string, it is converted to a string first.

                                                                                            +

                                                                                          Returns URL

                                                                                          v22.1.0

                                                                                          +

                                                                                        • Removes the stored Blob identified by the given ID. Attempting to revoke a ID that isn't registered will silently fail.

                                                                                          Parameters

                                                                                          • id: string

                                                                                            A 'blob:nodedata:... URL string returned by a prior call to URL.createObjectURL().

                                                                                            -

                                                                                          Returns void

                                                                                          v16.7.0

                                                                                          -

                                                                                        Settings

                                                                                        Member Visibility

                                                                                        On This Page

                                                                                        Constructors
                                                                                        Properties
                                                                                        Methods
                                                                                        +

                                                                                        Returns void

                                                                                        v16.7.0

                                                                                        +

                                                                                        Settings

                                                                                        Member Visibility

                                                                                        On This Page

                                                                                        Constructors
                                                                                        Properties
                                                                                        Methods
                                                                                        diff --git a/docs/classes/_internal_.URLSearchParams.html b/docs/classes/_internal_.URLSearchParams.html index 80ba8822..f5b0d640 100644 --- a/docs/classes/_internal_.URLSearchParams.html +++ b/docs/classes/_internal_.URLSearchParams.html @@ -9,7 +9,7 @@

                                                                                        v7.5.0, v6.13.0

                                                                                        -

                                                                                        Implements

                                                                                        Index

                                                                                        Constructors

                                                                                        constructor +

                                                                                        Implements

                                                                                        Index

                                                                                        Constructors

                                                                                        constructor

                                                                                        Properties

                                                                                        size

                                                                                        Methods

                                                                                        [iterator] append @@ -24,42 +24,42 @@ sort toString values -

                                                                                        Constructors

                                                                                        • Parameters

                                                                                          • Optionalinit:
                                                                                                | string
                                                                                                | URLSearchParams
                                                                                                | readonly [string, string][]
                                                                                                | Iterable<[string, string], any, any>
                                                                                                | Record<string, string | readonly string[]>

                                                                                          Returns URLSearchParams

                                                                                        Properties

                                                                                        size: number

                                                                                        The total number of parameter entries.

                                                                                        +

                                                                                        Constructors

                                                                                        • Parameters

                                                                                          • Optionalinit:
                                                                                                | string
                                                                                                | URLSearchParams
                                                                                                | readonly [string, string][]
                                                                                                | Iterable<[string, string], any, any>
                                                                                                | Record<string, string | readonly string[]>

                                                                                          Returns URLSearchParams

                                                                                        Properties

                                                                                        size: number

                                                                                        The total number of parameter entries.

                                                                                        v19.8.0

                                                                                        -

                                                                                        Methods

                                                                                        • Append a new name-value pair to the query string.

                                                                                          -

                                                                                          Parameters

                                                                                          • name: string
                                                                                          • value: string

                                                                                          Returns void

                                                                                        • If value is provided, removes all name-value pairs +

                                                                                        Methods

                                                                                        • Append a new name-value pair to the query string.

                                                                                          +

                                                                                          Parameters

                                                                                          • name: string
                                                                                          • value: string

                                                                                          Returns void

                                                                                        • If value is provided, removes all name-value pairs where name is name and value is value.

                                                                                          If value is not provided, removes all name-value pairs whose name is name.

                                                                                          -

                                                                                          Parameters

                                                                                          • name: string
                                                                                          • Optionalvalue: string

                                                                                          Returns void

                                                                                        • Returns an ES6 Iterator over each of the name-value pairs in the query. +

                                                                                          Parameters

                                                                                          • name: string
                                                                                          • Optionalvalue: string

                                                                                          Returns void

                                                                                        • Returns an ES6 Iterator over each of the name-value pairs in the query. Each item of the iterator is a JavaScript Array. The first item of the Array is the name, the second item of the Array is the value.

                                                                                          -

                                                                                          Alias for urlSearchParams[@@iterator]().

                                                                                          -

                                                                                          Returns URLSearchParamsIterator<[string, string]>

                                                                                        • Iterates over each name-value pair in the query and invokes the given function.

                                                                                          +

                                                                                          Alias for urlSearchParams[Symbol.iterator]().

                                                                                          +

                                                                                          Returns URLSearchParamsIterator<[string, string]>

                                                                                        • Iterates over each name-value pair in the query and invokes the given function.

                                                                                          const myURL = new URL('https://example.org/?a=b&#x26;c=d');
                                                                                          myURL.searchParams.forEach((value, name, searchParams) => {
                                                                                            console.log(name, value, myURL.searchParams === searchParams);
                                                                                          });
                                                                                          // Prints:
                                                                                          //   a b true
                                                                                          //   c d true

                                                                                          Type Parameters

                                                                                          Parameters

                                                                                          • fn: (
                                                                                                this: TThis,
                                                                                                value: string,
                                                                                                name: string,
                                                                                                searchParams: URLSearchParams,
                                                                                            ) => void

                                                                                            Invoked for each name-value pair in the query

                                                                                            -
                                                                                          • OptionalthisArg: TThis

                                                                                            To be used as this value for when fn is called

                                                                                            -

                                                                                          Returns void

                                                                                        • Returns the value of the first name-value pair whose name is name. If there +

                                                                                        • OptionalthisArg: TThis

                                                                                          To be used as this value for when fn is called

                                                                                          +

                                                                                        Returns void

                                                                                        • Returns the value of the first name-value pair whose name is name. If there are no such pairs, null is returned.

                                                                                          Parameters

                                                                                          • name: string

                                                                                          Returns string

                                                                                          or null if there is no name-value pair with the given name.

                                                                                          -

                                                                                        • Returns the values of all name-value pairs whose name is name. If there are +

                                                                                        • Returns the values of all name-value pairs whose name is name. If there are no such pairs, an empty array is returned.

                                                                                          -

                                                                                          Parameters

                                                                                          • name: string

                                                                                          Returns string[]

                                                                                        • Checks if the URLSearchParams object contains key-value pair(s) based on name and an optional value argument.

                                                                                          +

                                                                                          Parameters

                                                                                          • name: string

                                                                                          Returns string[]

                                                                                        • Checks if the URLSearchParams object contains key-value pair(s) based on name and an optional value argument.

                                                                                          If value is provided, returns true when name-value pair with same name and value exists.

                                                                                          If value is not provided, returns true if there is at least one name-value pair whose name is name.

                                                                                          -

                                                                                          Parameters

                                                                                          • name: string
                                                                                          • Optionalvalue: string

                                                                                          Returns boolean

                                                                                        • Returns an ES6 Iterator over the names of each name-value pair.

                                                                                          +

                                                                                          Parameters

                                                                                          • name: string
                                                                                          • Optionalvalue: string

                                                                                          Returns boolean

                                                                                        • Returns an ES6 Iterator over the names of each name-value pair.

                                                                                          const params = new URLSearchParams('foo=bar&#x26;foo=baz');
                                                                                          for (const name of params.keys()) {
                                                                                            console.log(name);
                                                                                          }
                                                                                          // Prints:
                                                                                          //   foo
                                                                                          //   foo
                                                                                          -

                                                                                          Returns URLSearchParamsIterator<string>

                                                                                        • Sets the value in the URLSearchParams object associated with name to value. If there are any pre-existing name-value pairs whose names are name, +

                                                                                          Returns URLSearchParamsIterator<string>

                                                                                        • Sets the value in the URLSearchParams object associated with name to value. If there are any pre-existing name-value pairs whose names are name, set the first such pair's value to value and remove all others. If not, append the name-value pair to the query string.

                                                                                          const params = new URLSearchParams();
                                                                                          params.append('foo', 'bar');
                                                                                          params.append('foo', 'baz');
                                                                                          params.append('abc', 'def');
                                                                                          console.log(params.toString());
                                                                                          // Prints foo=bar&#x26;foo=baz&#x26;abc=def

                                                                                          params.set('foo', 'def');
                                                                                          params.set('xyz', 'opq');
                                                                                          console.log(params.toString());
                                                                                          // Prints foo=def&#x26;abc=def&#x26;xyz=opq
                                                                                          -

                                                                                          Parameters

                                                                                          • name: string
                                                                                          • value: string

                                                                                          Returns void

                                                                                        • Sort all existing name-value pairs in-place by their names. Sorting is done +

                                                                                          Parameters

                                                                                          • name: string
                                                                                          • value: string

                                                                                          Returns void

                                                                                        • Sort all existing name-value pairs in-place by their names. Sorting is done with a stable sorting algorithm, so relative order between name-value pairs with the same name is preserved.

                                                                                          This method can be used, in particular, to increase cache hits.

                                                                                          @@ -67,7 +67,7 @@

                                                                                          Returns void

                                                                                          v7.7.0, v6.13.0

                                                                                          -

                                                                                        • Returns the search parameters serialized as a string, with characters +

                                                                                        • Returns the search parameters serialized as a string, with characters percent-encoded where necessary.

                                                                                          -

                                                                                          Returns string

                                                                                        Settings

                                                                                        Member Visibility

                                                                                        On This Page

                                                                                        Constructors
                                                                                        Properties
                                                                                        Methods
                                                                                        +

                                                                                        Returns string

                                                                                        Settings

                                                                                        Member Visibility

                                                                                        On This Page

                                                                                        Constructors
                                                                                        Properties
                                                                                        Methods
                                                                                        diff --git a/docs/classes/_internal_.YAMLError.html b/docs/classes/_internal_.YAMLError.html index 591e2d1d..5946740d 100644 --- a/docs/classes/_internal_.YAMLError.html +++ b/docs/classes/_internal_.YAMLError.html @@ -1,4 +1,4 @@ -YAMLError | ts-lambda-api - v2.5.2
                                                                                        ts-lambda-api - v2.5.2
                                                                                          Preparing search index...

                                                                                          Class YAMLError

                                                                                          Hierarchy (View Summary)

                                                                                          Index

                                                                                          Constructors

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

                                                                                            Class YAMLError

                                                                                            Hierarchy (View Summary)

                                                                                            Index

                                                                                            Constructors

                                                                                            constructor

                                                                                            Properties

                                                                                            cause? code linePos? @@ -16,7 +16,7 @@ will affect any stack trace captured after the value has been changed.

                                                                                            If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

                                                                                            -

                                                                                            Methods

                                                                                            • Creates a .stack property on targetObject, which when accessed returns +

                                                                                            Methods

                                                                                            • Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

                                                                                              const myObject = {};
                                                                                              Error.captureStackTrace(myObject);
                                                                                              myObject.stack;  // Similar to `new Error().stack`
@@ -32,5 +32,5 @@
 
                                                                                              function a() {
                                                                                                b();
                                                                                              }

                                                                                              function b() {
                                                                                                c();
                                                                                              }

                                                                                              function c() {
                                                                                                // Create an error without stack trace to avoid calculating the stack trace twice.
                                                                                                const { stackTraceLimit } = Error;
                                                                                                Error.stackTraceLimit = 0;
                                                                                                const error = new Error();
                                                                                                Error.stackTraceLimit = stackTraceLimit;

                                                                                                // Capture the stack trace above function b
                                                                                                Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
                                                                                                throw error;
                                                                                              }

                                                                                              a();
 
                                                                                              
 
-

                                                                                              Parameters

                                                                                              • targetObject: object
                                                                                              • OptionalconstructorOpt: Function

                                                                                              Returns void

                                                                                            Settings

                                                                                            Member Visibility

                                                                                            On This Page

                                                                                            Constructors
                                                                                            Properties
                                                                                            Methods
                                                                                            +

                                                                                            Parameters

                                                                                            • targetObject: object
                                                                                            • OptionalconstructorOpt: Function

                                                                                            Returns void

                                                                                            Settings

                                                                                            Member Visibility

                                                                                            On This Page

                                                                                            Constructors
                                                                                            Properties
                                                                                            Methods
                                                                                            diff --git a/docs/classes/_internal_.YAMLMap.html b/docs/classes/_internal_.YAMLMap.html index 6faa01f5..7621e765 100644 --- a/docs/classes/_internal_.YAMLMap.html +++ b/docs/classes/_internal_.YAMLMap.html @@ -1,4 +1,4 @@ -YAMLMap | ts-lambda-api - v2.5.2
                                                                                            ts-lambda-api - v2.5.2
                                                                                              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.2
                                                                                              ts-lambda-api - v2.5.2
                                                                                                Preparing search index...

                                                                                                Class YAMLMap<K, V>

                                                                                                Type Parameters

                                                                                                • K = unknown
                                                                                                • V = unknown

                                                                                                Hierarchy (View Summary)

                                                                                                Index

                                                                                                Constructors

                                                                                                constructor

                                                                                                Properties

                                                                                                [NODE_TYPE] addToJSMap? anchor? @@ -28,48 +28,48 @@ toJSON toString from -

                                                                                                Constructors

                                                                                                Properties

                                                                                                "[NODE_TYPE]": symbol
                                                                                                addToJSMap?: (ctx: ToJSContext, map: MapLike, value: unknown) => void

                                                                                                Customize the way that a key-value pair is resolved. +

                                                                                                Constructors

                                                                                                Properties

                                                                                                "[NODE_TYPE]": symbol
                                                                                                addToJSMap?: (ctx: ToJSContext, map: MapLike, value: unknown) => void

                                                                                                Customize the way that a key-value pair is resolved. Used for YAML 1.1 !!merge << handling.

                                                                                                -
                                                                                                anchor?: string

                                                                                                An optional anchor on this node. Used by alias nodes.

                                                                                                -
                                                                                                comment?: string

                                                                                                A comment on or immediately after this

                                                                                                -
                                                                                                commentBefore?: string

                                                                                                A comment before this

                                                                                                -
                                                                                                flow?: boolean

                                                                                                If true, stringify this and all child nodes using flow rather than +

                                                                                                anchor?: string

                                                                                                An optional anchor on this node. Used by alias nodes.

                                                                                                +
                                                                                                comment?: string

                                                                                                A comment on or immediately after this

                                                                                                +
                                                                                                commentBefore?: string

                                                                                                A comment before this

                                                                                                +
                                                                                                flow?: boolean

                                                                                                If true, stringify this and all child nodes using flow rather than block styles.

                                                                                                -
                                                                                                items: Pair<K, V>[]
                                                                                                range?: Range

                                                                                                The [start, value-end, node-end] character offsets for the part of the +

                                                                                                items: Pair<K, V>[]
                                                                                                range?: Range

                                                                                                The [start, value-end, node-end] character offsets for the part of the source parsed into this node (undefined if not parsed). The value-end and node-end positions are themselves not included in their respective ranges.

                                                                                                -
                                                                                                schema: Schema
                                                                                                spaceBefore?: boolean

                                                                                                A blank line before this node and its commentBefore

                                                                                                -
                                                                                                srcToken?: Token

                                                                                                The CST token that was composed into this node.

                                                                                                -
                                                                                                tag?: string

                                                                                                A fully qualified tag, if required

                                                                                                -

                                                                                                Accessors

                                                                                                • get tagName(): "tag:yaml.org,2002:map"

                                                                                                  Returns "tag:yaml.org,2002:map"

                                                                                                Methods

                                                                                                • Adds a value to the collection.

                                                                                                  -

                                                                                                  Parameters

                                                                                                  • pair: Pair<K, V> | { key: K; value: V }
                                                                                                  • Optionaloverwrite: boolean

                                                                                                    If not set true, using a key that is already in the +

                                                                                                schema: Schema
                                                                                                spaceBefore?: boolean

                                                                                                A blank line before this node and its commentBefore

                                                                                                +
                                                                                                srcToken?: Token

                                                                                                The CST token that was composed into this node.

                                                                                                +
                                                                                                tag?: string

                                                                                                A fully qualified tag, if required

                                                                                                +

                                                                                                Accessors

                                                                                                • get tagName(): "tag:yaml.org,2002:map"

                                                                                                  Returns "tag:yaml.org,2002:map"

                                                                                                Methods

                                                                                                • Adds a value to the collection.

                                                                                                  +

                                                                                                  Parameters

                                                                                                  • pair: Pair<K, V> | { key: K; value: V }
                                                                                                  • Optionaloverwrite: boolean

                                                                                                    If not set true, using a key that is already in the collection will throw. Otherwise, overwrites the previous value.

                                                                                                    -

                                                                                                  Returns void

                                                                                                • Adds a value to the collection. For !!map and !!omap the value must +

                                                                                                Returns void

                                                                                                • Adds a value to the collection. For !!map and !!omap the value must be a Pair instance or a { key, value } object, which may not have a key that already exists in the map.

                                                                                                  -

                                                                                                  Parameters

                                                                                                  Returns void

                                                                                                • Create a copy of this collection.

                                                                                                  +

                                                                                                  Parameters

                                                                                                  Returns void

                                                                                                • Create a copy of this collection.

                                                                                                  Parameters

                                                                                                  • Optionalschema: Schema

                                                                                                    If defined, overwrites the original's schema

                                                                                                    -

                                                                                                  Returns Collection

                                                                                                • Removes a value from the collection.

                                                                                                  +

                                                                                                Returns Collection

                                                                                                • Removes a value from the collection.

                                                                                                  Parameters

                                                                                                  • key: unknown

                                                                                                  Returns boolean

                                                                                                  true if the item was found and removed.

                                                                                                  -

                                                                                                • Removes a value from the collection.

                                                                                                  +

                                                                                                • Removes a value from the collection.

                                                                                                  Parameters

                                                                                                  Returns boolean

                                                                                                  true if the item was found and removed.

                                                                                                  -

                                                                                                • Returns item at key, or undefined if not found. By default unwraps +

                                                                                                • Returns item at key, or undefined if not found. By default unwraps scalar values from their surrounding node; to disable set keepScalar to true (collections are always returned intact).

                                                                                                  -

                                                                                                  Parameters

                                                                                                  • key: unknown
                                                                                                  • keepScalar: true

                                                                                                  Returns Scalar<V>

                                                                                                • Parameters

                                                                                                  • key: unknown
                                                                                                  • OptionalkeepScalar: false

                                                                                                  Returns V

                                                                                                • Parameters

                                                                                                  • key: unknown
                                                                                                  • OptionalkeepScalar: boolean

                                                                                                  Returns V | Scalar<V>

                                                                                                • Returns item at key, or undefined if not found. By default unwraps +

                                                                                                  Parameters

                                                                                                  • key: unknown
                                                                                                  • keepScalar: true

                                                                                                  Returns Scalar<V>

                                                                                                • Parameters

                                                                                                  • key: unknown
                                                                                                  • OptionalkeepScalar: false

                                                                                                  Returns V

                                                                                                • Parameters

                                                                                                  • key: unknown
                                                                                                  • OptionalkeepScalar: boolean

                                                                                                  Returns V | Scalar<V>

                                                                                                • Returns item at key, or undefined if not found. By default unwraps scalar values from their surrounding node; to disable set keepScalar to true (collections are always returned intact).

                                                                                                  -

                                                                                                  Parameters

                                                                                                  • path: Iterable<unknown>
                                                                                                  • OptionalkeepScalar: boolean

                                                                                                  Returns unknown

                                                                                                • Checks if the collection includes a value with the key key.

                                                                                                  -

                                                                                                  Parameters

                                                                                                  • key: unknown

                                                                                                  Returns boolean

                                                                                                • Parameters

                                                                                                  • OptionalallowScalar: boolean

                                                                                                  Returns boolean

                                                                                                • Checks if the collection includes a value with the key key.

                                                                                                  -

                                                                                                  Parameters

                                                                                                  Returns boolean

                                                                                                • Sets a value in this collection. For !!set, value needs to be a +

                                                                                                  Parameters

                                                                                                  • path: Iterable<unknown>
                                                                                                  • OptionalkeepScalar: boolean

                                                                                                  Returns unknown

                                                                                                • Checks if the collection includes a value with the key key.

                                                                                                  +

                                                                                                  Parameters

                                                                                                  • key: unknown

                                                                                                  Returns boolean

                                                                                                • Parameters

                                                                                                  • OptionalallowScalar: boolean

                                                                                                  Returns boolean

                                                                                                • Checks if the collection includes a value with the key key.

                                                                                                  +

                                                                                                  Parameters

                                                                                                  Returns boolean

                                                                                                • Sets a value in this collection. For !!set, value needs to be a boolean to add/remove the item from the set.

                                                                                                  -

                                                                                                  Parameters

                                                                                                  • key: K
                                                                                                  • value: V

                                                                                                  Returns void

                                                                                                • Sets a value in this collection. For !!set, value needs to be a +

                                                                                                  Parameters

                                                                                                  • key: K
                                                                                                  • value: V

                                                                                                  Returns void

                                                                                                • Sets a value in this collection. For !!set, value needs to be a boolean to add/remove the item from the set.

                                                                                                  -

                                                                                                  Parameters

                                                                                                  Returns void

                                                                                                • A plain JavaScript representation of this node.

                                                                                                  -

                                                                                                  Parameters

                                                                                                  Returns any

                                                                                                • Type Parameters

                                                                                                  • T extends MapLike = Map<unknown, unknown>

                                                                                                  Parameters

                                                                                                  • Optional_: unknown
                                                                                                  • Optionalctx: ToJSContext

                                                                                                    Conversion context, originally set in Document#toJS()

                                                                                                    -
                                                                                                  • OptionalType: new () => T

                                                                                                    If set, forces the returned collection type

                                                                                                    -

                                                                                                  Returns any

                                                                                                  Instance of Type, Map, or Object

                                                                                                  -

                                                                                                • Parameters

                                                                                                  • Optionalctx: StringifyContext
                                                                                                  • OptionalonComment: () => void
                                                                                                  • OptionalonChompKeep: () => void

                                                                                                  Returns string

                                                                                                • A generic collection parsing method that can be extended +

                                                                                                  Parameters

                                                                                                  Returns void

                                                                                                • A plain JavaScript representation of this node.

                                                                                                  +

                                                                                                  Parameters

                                                                                                  Returns any

                                                                                                • Type Parameters

                                                                                                  • T extends MapLike = Map<unknown, unknown>

                                                                                                  Parameters

                                                                                                  • Optional_: unknown
                                                                                                  • Optionalctx: ToJSContext

                                                                                                    Conversion context, originally set in Document#toJS()

                                                                                                    +
                                                                                                  • OptionalType: new () => T

                                                                                                    If set, forces the returned collection type

                                                                                                    +

                                                                                                  Returns any

                                                                                                  Instance of Type, Map, or Object

                                                                                                  +

                                                                                                • Parameters

                                                                                                  • Optionalctx: StringifyContext
                                                                                                  • OptionalonComment: () => void
                                                                                                  • OptionalonChompKeep: () => void

                                                                                                  Returns string

                                                                                                • A generic collection parsing method that can be extended to other node classes that inherit from YAMLMap

                                                                                                  -

                                                                                                  Parameters

                                                                                                  Returns YAMLMap

                                                                                                Settings

                                                                                                Member Visibility

                                                                                                On This Page

                                                                                                Constructors
                                                                                                Properties
                                                                                                Accessors
                                                                                                Methods
                                                                                                +

                                                                                                Parameters

                                                                                                Returns YAMLMap

                                                                                                Settings

                                                                                                Member Visibility

                                                                                                On This Page

                                                                                                Constructors
                                                                                                Properties
                                                                                                Accessors
                                                                                                Methods
                                                                                                diff --git a/docs/classes/_internal_.YAMLSeq.html b/docs/classes/_internal_.YAMLSeq.html index a2aacbea..7dfcf5a8 100644 --- a/docs/classes/_internal_.YAMLSeq.html +++ b/docs/classes/_internal_.YAMLSeq.html @@ -1,4 +1,4 @@ -YAMLSeq | ts-lambda-api - v2.5.2
                                                                                                ts-lambda-api - v2.5.2
                                                                                                  Preparing search index...

                                                                                                  Class YAMLSeq<T>

                                                                                                  Type Parameters

                                                                                                  • T = unknown

                                                                                                  Hierarchy (View Summary)

                                                                                                  Index

                                                                                                  Constructors

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

                                                                                                    Class YAMLSeq<T>

                                                                                                    Type Parameters

                                                                                                    • T = unknown

                                                                                                    Hierarchy (View Summary)

                                                                                                    Index

                                                                                                    Constructors

                                                                                                    constructor

                                                                                                    Properties

                                                                                                    [NODE_TYPE] addToJSMap? anchor? @@ -28,60 +28,60 @@ toJSON toString from -

                                                                                                    Constructors

                                                                                                    Properties

                                                                                                    "[NODE_TYPE]": symbol
                                                                                                    addToJSMap?: (ctx: ToJSContext, map: MapLike, value: unknown) => void

                                                                                                    Customize the way that a key-value pair is resolved. +

                                                                                                    Constructors

                                                                                                    Properties

                                                                                                    "[NODE_TYPE]": symbol
                                                                                                    addToJSMap?: (ctx: ToJSContext, map: MapLike, value: unknown) => void

                                                                                                    Customize the way that a key-value pair is resolved. Used for YAML 1.1 !!merge << handling.

                                                                                                    -
                                                                                                    anchor?: string

                                                                                                    An optional anchor on this node. Used by alias nodes.

                                                                                                    -
                                                                                                    comment?: string

                                                                                                    A comment on or immediately after this

                                                                                                    -
                                                                                                    commentBefore?: string

                                                                                                    A comment before this

                                                                                                    -
                                                                                                    flow?: boolean

                                                                                                    If true, stringify this and all child nodes using flow rather than +

                                                                                                    anchor?: string

                                                                                                    An optional anchor on this node. Used by alias nodes.

                                                                                                    +
                                                                                                    comment?: string

                                                                                                    A comment on or immediately after this

                                                                                                    +
                                                                                                    commentBefore?: string

                                                                                                    A comment before this

                                                                                                    +
                                                                                                    flow?: boolean

                                                                                                    If true, stringify this and all child nodes using flow rather than block styles.

                                                                                                    -
                                                                                                    items: T[]
                                                                                                    range?: Range

                                                                                                    The [start, value-end, node-end] character offsets for the part of the +

                                                                                                    items: T[]
                                                                                                    range?: Range

                                                                                                    The [start, value-end, node-end] character offsets for the part of the source parsed into this node (undefined if not parsed). The value-end and node-end positions are themselves not included in their respective ranges.

                                                                                                    -
                                                                                                    schema: Schema
                                                                                                    spaceBefore?: boolean

                                                                                                    A blank line before this node and its commentBefore

                                                                                                    -
                                                                                                    srcToken?: Token

                                                                                                    The CST token that was composed into this node.

                                                                                                    -
                                                                                                    tag?: string

                                                                                                    A fully qualified tag, if required

                                                                                                    -

                                                                                                    Accessors

                                                                                                    • get tagName(): "tag:yaml.org,2002:seq"

                                                                                                      Returns "tag:yaml.org,2002:seq"

                                                                                                    Methods

                                                                                                    • Adds a value to the collection.

                                                                                                      -

                                                                                                      Parameters

                                                                                                      • value: T

                                                                                                      Returns void

                                                                                                    • Adds a value to the collection. For !!map and !!omap the value must +

                                                                                                    schema: Schema
                                                                                                    spaceBefore?: boolean

                                                                                                    A blank line before this node and its commentBefore

                                                                                                    +
                                                                                                    srcToken?: Token

                                                                                                    The CST token that was composed into this node.

                                                                                                    +
                                                                                                    tag?: string

                                                                                                    A fully qualified tag, if required

                                                                                                    +

                                                                                                    Accessors

                                                                                                    • get tagName(): "tag:yaml.org,2002:seq"

                                                                                                      Returns "tag:yaml.org,2002:seq"

                                                                                                    Methods

                                                                                                    • Adds a value to the collection.

                                                                                                      +

                                                                                                      Parameters

                                                                                                      • value: T

                                                                                                      Returns void

                                                                                                    • Adds a value to the collection. For !!map and !!omap the value must be a Pair instance or a { key, value } object, which may not have a key that already exists in the map.

                                                                                                      -

                                                                                                      Parameters

                                                                                                      Returns void

                                                                                                    • Create a copy of this collection.

                                                                                                      +

                                                                                                      Parameters

                                                                                                      Returns void

                                                                                                    • Create a copy of this collection.

                                                                                                      Parameters

                                                                                                      • Optionalschema: Schema

                                                                                                        If defined, overwrites the original's schema

                                                                                                        -

                                                                                                      Returns Collection

                                                                                                    • Removes a value from the collection.

                                                                                                      +

                                                                                                    Returns Collection

                                                                                                    • Removes a value from the collection.

                                                                                                      key must contain a representation of an integer for this to succeed. It may be wrapped in a Scalar.

                                                                                                      Parameters

                                                                                                      • key: unknown

                                                                                                      Returns boolean

                                                                                                      true if the item was found and removed.

                                                                                                      -

                                                                                                    • Removes a value from the collection.

                                                                                                      +

                                                                                                    • Removes a value from the collection.

                                                                                                      Parameters

                                                                                                      Returns boolean

                                                                                                      true if the item was found and removed.

                                                                                                      -

                                                                                                    • Returns item at key, or undefined if not found. By default unwraps +

                                                                                                    • Returns item at key, or undefined if not found. By default unwraps scalar values from their surrounding node; to disable set keepScalar to true (collections are always returned intact).

                                                                                                      key must contain a representation of an integer for this to succeed. It may be wrapped in a Scalar.

                                                                                                      -

                                                                                                      Parameters

                                                                                                      • key: unknown
                                                                                                      • keepScalar: true

                                                                                                      Returns Scalar<T>

                                                                                                    • Returns item at key, or undefined if not found. By default unwraps +

                                                                                                      Parameters

                                                                                                      • key: unknown
                                                                                                      • keepScalar: true

                                                                                                      Returns Scalar<T>

                                                                                                    • Returns item at key, or undefined if not found. By default unwraps scalar values from their surrounding node; to disable set keepScalar to true (collections are always returned intact).

                                                                                                      key must contain a representation of an integer for this to succeed. It may be wrapped in a Scalar.

                                                                                                      -

                                                                                                      Parameters

                                                                                                      • key: unknown
                                                                                                      • OptionalkeepScalar: false

                                                                                                      Returns T

                                                                                                    • Returns item at key, or undefined if not found. By default unwraps +

                                                                                                      Parameters

                                                                                                      • key: unknown
                                                                                                      • OptionalkeepScalar: false

                                                                                                      Returns T

                                                                                                    • Returns item at key, or undefined if not found. By default unwraps scalar values from their surrounding node; to disable set keepScalar to true (collections are always returned intact).

                                                                                                      key must contain a representation of an integer for this to succeed. It may be wrapped in a Scalar.

                                                                                                      -

                                                                                                      Parameters

                                                                                                      • key: unknown
                                                                                                      • OptionalkeepScalar: boolean

                                                                                                      Returns T | Scalar<T>

                                                                                                    • Returns item at key, or undefined if not found. By default unwraps +

                                                                                                      Parameters

                                                                                                      • key: unknown
                                                                                                      • OptionalkeepScalar: boolean

                                                                                                      Returns T | Scalar<T>

                                                                                                    • Returns item at key, or undefined if not found. By default unwraps scalar values from their surrounding node; to disable set keepScalar to true (collections are always returned intact).

                                                                                                      -

                                                                                                      Parameters

                                                                                                      • path: Iterable<unknown>
                                                                                                      • OptionalkeepScalar: boolean

                                                                                                      Returns unknown

                                                                                                    • Checks if the collection includes a value with the key key.

                                                                                                      +

                                                                                                      Parameters

                                                                                                      • path: Iterable<unknown>
                                                                                                      • OptionalkeepScalar: boolean

                                                                                                      Returns unknown

                                                                                                    • Checks if the collection includes a value with the key key.

                                                                                                      key must contain a representation of an integer for this to succeed. It may be wrapped in a Scalar.

                                                                                                      -

                                                                                                      Parameters

                                                                                                      • key: unknown

                                                                                                      Returns boolean

                                                                                                    • Parameters

                                                                                                      • OptionalallowScalar: boolean

                                                                                                      Returns boolean

                                                                                                    • Checks if the collection includes a value with the key key.

                                                                                                      -

                                                                                                      Parameters

                                                                                                      Returns boolean

                                                                                                    • Sets a value in this collection. For !!set, value needs to be a +

                                                                                                      Parameters

                                                                                                      • key: unknown

                                                                                                      Returns boolean

                                                                                                    • Parameters

                                                                                                      • OptionalallowScalar: boolean

                                                                                                      Returns boolean

                                                                                                    • Checks if the collection includes a value with the key key.

                                                                                                      +

                                                                                                      Parameters

                                                                                                      Returns boolean

                                                                                                    • Sets a value in this collection. For !!set, value needs to be a boolean to add/remove the item from the set.

                                                                                                      If key does not contain a representation of an integer, this will throw. It may be wrapped in a Scalar.

                                                                                                      -

                                                                                                      Parameters

                                                                                                      • key: unknown
                                                                                                      • value: T

                                                                                                      Returns void

                                                                                                    • Sets a value in this collection. For !!set, value needs to be a +

                                                                                                      Parameters

                                                                                                      • key: unknown
                                                                                                      • value: T

                                                                                                      Returns void

                                                                                                    • Sets a value in this collection. For !!set, value needs to be a boolean to add/remove the item from the set.

                                                                                                      -

                                                                                                      Parameters

                                                                                                      Returns void

                                                                                                    • A plain JavaScript representation of this node.

                                                                                                      -

                                                                                                      Parameters

                                                                                                      Returns any

                                                                                                    • A plain JS representation of this node

                                                                                                      -

                                                                                                      Parameters

                                                                                                      Returns unknown[]

                                                                                                    • Parameters

                                                                                                      • Optionalctx: StringifyContext
                                                                                                      • OptionalonComment: () => void
                                                                                                      • OptionalonChompKeep: () => void

                                                                                                      Returns string

                                                                                                    Settings

                                                                                                    Member Visibility

                                                                                                    On This Page

                                                                                                    Constructors
                                                                                                    Properties
                                                                                                    Accessors
                                                                                                    Methods
                                                                                                    +

                                                                                                    Parameters

                                                                                                    Returns void

                                                                                                    • A plain JavaScript representation of this node.

                                                                                                      +

                                                                                                      Parameters

                                                                                                      Returns any

                                                                                                    • A plain JS representation of this node

                                                                                                      +

                                                                                                      Parameters

                                                                                                      Returns unknown[]

                                                                                                    • Parameters

                                                                                                      • Optionalctx: StringifyContext
                                                                                                      • OptionalonComment: () => void
                                                                                                      • OptionalonChompKeep: () => void

                                                                                                      Returns string

                                                                                                    Settings

                                                                                                    Member Visibility

                                                                                                    On This Page

                                                                                                    Constructors
                                                                                                    Properties
                                                                                                    Accessors
                                                                                                    Methods
                                                                                                    diff --git a/docs/classes/_internal_.YAMLWarning.html b/docs/classes/_internal_.YAMLWarning.html index 88eb0230..d2cb54e9 100644 --- a/docs/classes/_internal_.YAMLWarning.html +++ b/docs/classes/_internal_.YAMLWarning.html @@ -1,4 +1,4 @@ -YAMLWarning | ts-lambda-api - v2.5.2
                                                                                                    ts-lambda-api - v2.5.2
                                                                                                      Preparing search index...

                                                                                                      Class YAMLWarning

                                                                                                      Hierarchy (View Summary)

                                                                                                      Index

                                                                                                      Constructors

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

                                                                                                        Class YAMLWarning

                                                                                                        Hierarchy (View Summary)

                                                                                                        Index

                                                                                                        Constructors

                                                                                                        constructor

                                                                                                        Properties

                                                                                                        cause? code linePos? @@ -16,7 +16,7 @@ will affect any stack trace captured after the value has been changed.

                                                                                                        If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

                                                                                                        -

                                                                                                        Methods

                                                                                                        • Creates a .stack property on targetObject, which when accessed returns +

                                                                                                        Methods

                                                                                                        • Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

                                                                                                          const myObject = {};
                                                                                                          Error.captureStackTrace(myObject);
                                                                                                          myObject.stack;  // Similar to `new Error().stack`
@@ -32,5 +32,5 @@
 
                                                                                                          function a() {
                                                                                                            b();
                                                                                                          }

                                                                                                          function b() {
                                                                                                            c();
                                                                                                          }

                                                                                                          function c() {
                                                                                                            // Create an error without stack trace to avoid calculating the stack trace twice.
                                                                                                            const { stackTraceLimit } = Error;
                                                                                                            Error.stackTraceLimit = 0;
                                                                                                            const error = new Error();
                                                                                                            Error.stackTraceLimit = stackTraceLimit;

                                                                                                            // Capture the stack trace above function b
                                                                                                            Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
                                                                                                            throw error;
                                                                                                          }

                                                                                                          a();
 
                                                                                                          
 
-

                                                                                                          Parameters

                                                                                                          • targetObject: object
                                                                                                          • OptionalconstructorOpt: Function

                                                                                                          Returns void

                                                                                                        Settings

                                                                                                        Member Visibility

                                                                                                        On This Page

                                                                                                        Constructors
                                                                                                        Properties
                                                                                                        Methods
                                                                                                        +

                                                                                                        Parameters

                                                                                                        • targetObject: object
                                                                                                        • OptionalconstructorOpt: Function

                                                                                                        Returns void

                                                                                                        Settings

                                                                                                        Member Visibility

                                                                                                        On This Page

                                                                                                        Constructors
                                                                                                        Properties
                                                                                                        Methods
                                                                                                        diff --git a/docs/functions/DELETE.html b/docs/functions/DELETE.html index c03887ac..78fd005c 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 b754abe0..913fd392 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 990b2789..e9a9701b 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 448dc31a..edb7eb23 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 ba74426d..ca1c6b9b 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/_internal_.Stream.addAbortSignal.html b/docs/functions/_internal_.Stream.addAbortSignal.html index 19f67017..c7f111e4 100644 --- a/docs/functions/_internal_.Stream.addAbortSignal.html +++ b/docs/functions/_internal_.Stream.addAbortSignal.html @@ -15,6 +15,6 @@

                                                                                                        Type Parameters

                                                                                                        Parameters

                                                                                                        • signal: AbortSignal

                                                                                                          A signal representing possible cancellation

                                                                                                          -
                                                                                                        • stream: T

                                                                                                          A stream to attach a signal to.

                                                                                                          -

                                                                                                        Returns T

                                                                                                        v15.4.0

                                                                                                        -

                                                                                                        Settings

                                                                                                        Member Visibility
                                                                                                        +
                                                                                                      • stream: T

                                                                                                        A stream to attach a signal to.

                                                                                                        +

                                                                                                        • Returns T

                                                                                                        v15.4.0

                                                                                                        +

                                                                                                        Settings

                                                                                                        Member Visibility
                                                                                                        diff --git a/docs/functions/_internal_.Stream.duplexPair.html b/docs/functions/_internal_.Stream.duplexPair.html index a62b12d6..039af4bc 100644 --- a/docs/functions/_internal_.Stream.duplexPair.html +++ b/docs/functions/_internal_.Stream.duplexPair.html @@ -10,5 +10,5 @@ difference in behavior.

                                                                                                        Parameters

                                                                                                        • Optionaloptions: DuplexOptions

                                                                                                          A value to pass to both Duplex constructors, to set options such as buffering.

                                                                                                          -

                                                                                                        Returns [Duplex, Duplex]

                                                                                                        v22.6.0

                                                                                                        -

                                                                                                        Settings

                                                                                                        Member Visibility
                                                                                                        +

                                                                                                        Returns [Duplex, Duplex]

                                                                                                        v22.6.0

                                                                                                        +

                                                                                                        Settings

                                                                                                        Member Visibility
                                                                                                        diff --git a/docs/functions/_internal_.Stream.finished.__promisify__.html b/docs/functions/_internal_.Stream.finished.__promisify__.html index aa0b8091..40d8711a 100644 --- a/docs/functions/_internal_.Stream.finished.__promisify__.html +++ b/docs/functions/_internal_.Stream.finished.__promisify__.html @@ -1 +1 @@ -__promisify__ | ts-lambda-api - v2.5.2
                                                                                                        ts-lambda-api - v2.5.2
                                                                                                          Preparing search index...

                                                                                                          Function __promisify__

                                                                                                          Settings

                                                                                                          Member Visibility
                                                                                                          +__promisify__ | ts-lambda-api - v2.5.2
                                                                                                          ts-lambda-api - v2.5.2
                                                                                                            Preparing search index...

                                                                                                            Function __promisify__

                                                                                                            Settings

                                                                                                            Member Visibility
                                                                                                            diff --git a/docs/functions/_internal_.Stream.finished.html b/docs/functions/_internal_.Stream.finished.html index 276049af..d5f0c380 100644 --- a/docs/functions/_internal_.Stream.finished.html +++ b/docs/functions/_internal_.Stream.finished.html @@ -16,10 +16,10 @@

                                                                                                            Parameters

                                                                                                            Returns () => void

                                                                                                            A cleanup function which removes all registered listeners.

                                                                                                            +
                                                                                                          • options: Stream.FinishedOptions
                                                                                                          • callback: (err?: ErrnoException) => void

                                                                                                            A callback function that takes an optional error argument.

                                                                                                            +

                                                                                                            • Returns () => void

                                                                                                            A cleanup function which removes all registered listeners.

                                                                                                            v10.0.0

                                                                                                            -

                                                                                                          • A readable and/or writable stream/webstream.

                                                                                                            +

                                                                                                          • A readable and/or writable stream/webstream.

                                                                                                            A function to get notified when a stream is no longer readable, writable or has experienced an error or a premature close event.

                                                                                                            import { finished } from 'node:stream';
                                                                                                            import fs from 'node:fs';

                                                                                                            const rs = fs.createReadStream('archive.tar');

                                                                                                            finished(rs, (err) => {
                                                                                                              if (err) {
                                                                                                                console.error('Stream failed.', err);
                                                                                                              } else {
                                                                                                                console.log('Stream is done reading.');
                                                                                                              }
                                                                                                            });

                                                                                                            rs.resume(); // Drain the stream.
@@ -37,7 +37,7 @@

                                                                                                            Parameters

                                                                                                            Returns () => void

                                                                                                            A cleanup function which removes all registered listeners.

                                                                                                            +
                                                                                                          • callback: (err?: ErrnoException) => void

                                                                                                            A callback function that takes an optional error argument.

                                                                                                            +

                                                                                                            • Returns () => void

                                                                                                            A cleanup function which removes all registered listeners.

                                                                                                            v10.0.0

                                                                                                            -

                                                                                                            Settings

                                                                                                            Member Visibility
                                                                                                            +

                                                                                                            Settings

                                                                                                            Member Visibility
                                                                                                            diff --git a/docs/functions/_internal_.Stream.getDefaultHighWaterMark.html b/docs/functions/_internal_.Stream.getDefaultHighWaterMark.html index 85c97317..765f0201 100644 --- a/docs/functions/_internal_.Stream.getDefaultHighWaterMark.html +++ b/docs/functions/_internal_.Stream.getDefaultHighWaterMark.html @@ -1,4 +1,4 @@ getDefaultHighWaterMark | ts-lambda-api - v2.5.2
                                                                                                            ts-lambda-api - v2.5.2
                                                                                                              Preparing search index...

                                                                                                              Function getDefaultHighWaterMark

                                                                                                              • Returns the default highWaterMark used by streams. Defaults to 65536 (64 KiB), or 16 for objectMode.

                                                                                                                Parameters

                                                                                                                • objectMode: boolean

                                                                                                                Returns number

                                                                                                                v19.9.0

                                                                                                                -

                                                                                                              Settings

                                                                                                              Member Visibility
                                                                                                              +

                                                                                                              Settings

                                                                                                              Member Visibility
                                                                                                              diff --git a/docs/functions/_internal_.Stream.isErrored.html b/docs/functions/_internal_.Stream.isErrored.html index 86c7b595..329335cb 100644 --- a/docs/functions/_internal_.Stream.isErrored.html +++ b/docs/functions/_internal_.Stream.isErrored.html @@ -1,3 +1,3 @@ isErrored | ts-lambda-api - v2.5.2
                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                Preparing search index...

                                                                                                                Function isErrored

                                                                                                                Settings

                                                                                                                Member Visibility
                                                                                                                +

                                                                                                                Settings

                                                                                                                Member Visibility
                                                                                                                diff --git a/docs/functions/_internal_.Stream.isReadable.html b/docs/functions/_internal_.Stream.isReadable.html index 0a303d35..2b458fae 100644 --- a/docs/functions/_internal_.Stream.isReadable.html +++ b/docs/functions/_internal_.Stream.isReadable.html @@ -1,3 +1,4 @@ isReadable | ts-lambda-api - v2.5.2
                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                  Preparing search index...

                                                                                                                  Function isReadable

                                                                                                                  • Returns whether the stream is readable.

                                                                                                                    -

                                                                                                                    Parameters

                                                                                                                    Returns boolean

                                                                                                                    v17.4.0, v16.14.0

                                                                                                                    -

                                                                                                                  Settings

                                                                                                                  Member Visibility
                                                                                                                  +

                                                                                                                  Parameters

                                                                                                                  Returns boolean

                                                                                                                  Only returns null if stream is not a valid Readable, Duplex or ReadableStream.

                                                                                                                  +

                                                                                                                  v17.4.0, v16.14.0

                                                                                                                  +

                                                                                                                  Settings

                                                                                                                  Member Visibility
                                                                                                                  diff --git a/docs/functions/_internal_.Stream.isWritable.html b/docs/functions/_internal_.Stream.isWritable.html new file mode 100644 index 00000000..09fff1ff --- /dev/null +++ b/docs/functions/_internal_.Stream.isWritable.html @@ -0,0 +1,4 @@ +isWritable | ts-lambda-api - v2.5.2
                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                    Preparing search index...

                                                                                                                    Function isWritable

                                                                                                                    • Returns whether the stream is writable.

                                                                                                                      +

                                                                                                                      Parameters

                                                                                                                      Returns boolean

                                                                                                                      Only returns null if stream is not a valid Writable, Duplex or WritableStream.

                                                                                                                      +

                                                                                                                      v20.0.0

                                                                                                                      +

                                                                                                                    Settings

                                                                                                                    Member Visibility
                                                                                                                    diff --git a/docs/functions/_internal_.Stream.pipeline.__promisify__.html b/docs/functions/_internal_.Stream.pipeline.__promisify__.html index 241e5624..54ce977b 100644 --- a/docs/functions/_internal_.Stream.pipeline.__promisify__.html +++ b/docs/functions/_internal_.Stream.pipeline.__promisify__.html @@ -1 +1 @@ -__promisify__ | ts-lambda-api - v2.5.2
                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                      Preparing search index...

                                                                                                                      Function __promisify__

                                                                                                                      Settings

                                                                                                                      Member Visibility
                                                                                                                      +__promisify__ | ts-lambda-api - v2.5.2
                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                        Preparing search index...

                                                                                                                        Function __promisify__

                                                                                                                        Settings

                                                                                                                        Member Visibility
                                                                                                                        diff --git a/docs/functions/_internal_.Stream.pipeline.html b/docs/functions/_internal_.Stream.pipeline.html index c9051303..732bf2ea 100644 --- a/docs/functions/_internal_.Stream.pipeline.html +++ b/docs/functions/_internal_.Stream.pipeline.html @@ -22,8 +22,8 @@

                                                                                                                        Type Parameters

                                                                                                                        Parameters

                                                                                                                        Returns B extends WritableStream ? B<B> : WritableStream

                                                                                                                        v10.0.0

                                                                                                                        -

                                                                                                                      • A module method to pipe between streams and generators forwarding errors and +

                                                                                                                        • Returns B extends WritableStream ? B<B> : WritableStream

                                                                                                                        v10.0.0

                                                                                                                        +

                                                                                                                      • A module method to pipe between streams and generators forwarding errors and properly cleaning up and provide a callback when the pipeline is complete.

                                                                                                                        import { pipeline } from 'node:stream';
                                                                                                                        import fs from 'node:fs';
                                                                                                                        import zlib from 'node:zlib';

                                                                                                                        // Use the pipeline API to easily pipe a series of streams
                                                                                                                        // together and get notified when the pipeline is fully done.

                                                                                                                        // A pipeline to gzip a potentially huge tar file efficiently:

                                                                                                                        pipeline(
                                                                                                                          fs.createReadStream('archive.tar'),
                                                                                                                          zlib.createGzip(),
                                                                                                                          fs.createWriteStream('archive.tar.gz'),
                                                                                                                          (err) => {
                                                                                                                            if (err) {
                                                                                                                              console.error('Pipeline failed.', err);
                                                                                                                            } else {
                                                                                                                              console.log('Pipeline succeeded.');
                                                                                                                            }
                                                                                                                          },
                                                                                                                        );
                                                                                                                        @@ -47,8 +47,8 @@

                                                                                                                        Type Parameters

                                                                                                                        Parameters

                                                                                                                        • source: A
                                                                                                                        • transform1: T1
                                                                                                                        • destination: B
                                                                                                                        • callback: PipelineCallback<B>

                                                                                                                          Called when the pipeline is fully done.

                                                                                                                          -

                                                                                                                        Returns B extends WritableStream ? B<B> : WritableStream

                                                                                                                        v10.0.0

                                                                                                                        -

                                                                                                                      • A module method to pipe between streams and generators forwarding errors and +

                                                                                                                        • Returns B extends WritableStream ? B<B> : WritableStream

                                                                                                                        v10.0.0

                                                                                                                        +

                                                                                                                      • A module method to pipe between streams and generators forwarding errors and properly cleaning up and provide a callback when the pipeline is complete.

                                                                                                                        import { pipeline } from 'node:stream';
                                                                                                                        import fs from 'node:fs';
                                                                                                                        import zlib from 'node:zlib';

                                                                                                                        // Use the pipeline API to easily pipe a series of streams
                                                                                                                        // together and get notified when the pipeline is fully done.

                                                                                                                        // A pipeline to gzip a potentially huge tar file efficiently:

                                                                                                                        pipeline(
                                                                                                                          fs.createReadStream('archive.tar'),
                                                                                                                          zlib.createGzip(),
                                                                                                                          fs.createWriteStream('archive.tar.gz'),
                                                                                                                          (err) => {
                                                                                                                            if (err) {
                                                                                                                              console.error('Pipeline failed.', err);
                                                                                                                            } else {
                                                                                                                              console.log('Pipeline succeeded.');
                                                                                                                            }
                                                                                                                          },
                                                                                                                        );
                                                                                                                        @@ -72,8 +72,8 @@

                                                                                                                        Type Parameters

                                                                                                                        Parameters

                                                                                                                        • source: A
                                                                                                                        • transform1: T1
                                                                                                                        • transform2: T2
                                                                                                                        • destination: B
                                                                                                                        • callback: PipelineCallback<B>

                                                                                                                          Called when the pipeline is fully done.

                                                                                                                          -

                                                                                                                        Returns B extends WritableStream ? B<B> : WritableStream

                                                                                                                        v10.0.0

                                                                                                                        -

                                                                                                                      • A module method to pipe between streams and generators forwarding errors and +

                                                                                                                        • Returns B extends WritableStream ? B<B> : WritableStream

                                                                                                                        v10.0.0

                                                                                                                        +

                                                                                                                      • A module method to pipe between streams and generators forwarding errors and properly cleaning up and provide a callback when the pipeline is complete.

                                                                                                                        import { pipeline } from 'node:stream';
                                                                                                                        import fs from 'node:fs';
                                                                                                                        import zlib from 'node:zlib';

                                                                                                                        // Use the pipeline API to easily pipe a series of streams
                                                                                                                        // together and get notified when the pipeline is fully done.

                                                                                                                        // A pipeline to gzip a potentially huge tar file efficiently:

                                                                                                                        pipeline(
                                                                                                                          fs.createReadStream('archive.tar'),
                                                                                                                          zlib.createGzip(),
                                                                                                                          fs.createWriteStream('archive.tar.gz'),
                                                                                                                          (err) => {
                                                                                                                            if (err) {
                                                                                                                              console.error('Pipeline failed.', err);
                                                                                                                            } else {
                                                                                                                              console.log('Pipeline succeeded.');
                                                                                                                            }
                                                                                                                          },
                                                                                                                        );
                                                                                                                        @@ -97,8 +97,8 @@

                                                                                                                        Type Parameters

                                                                                                                        Parameters

                                                                                                                        • source: A
                                                                                                                        • transform1: T1
                                                                                                                        • transform2: T2
                                                                                                                        • transform3: T3
                                                                                                                        • destination: B
                                                                                                                        • callback: PipelineCallback<B>

                                                                                                                          Called when the pipeline is fully done.

                                                                                                                          -

                                                                                                                        Returns B extends WritableStream ? B<B> : WritableStream

                                                                                                                        v10.0.0

                                                                                                                        -

                                                                                                                      • A module method to pipe between streams and generators forwarding errors and +

                                                                                                                        • Returns B extends WritableStream ? B<B> : WritableStream

                                                                                                                        v10.0.0

                                                                                                                        +

                                                                                                                      • A module method to pipe between streams and generators forwarding errors and properly cleaning up and provide a callback when the pipeline is complete.

                                                                                                                        import { pipeline } from 'node:stream';
                                                                                                                        import fs from 'node:fs';
                                                                                                                        import zlib from 'node:zlib';

                                                                                                                        // Use the pipeline API to easily pipe a series of streams
                                                                                                                        // together and get notified when the pipeline is fully done.

                                                                                                                        // A pipeline to gzip a potentially huge tar file efficiently:

                                                                                                                        pipeline(
                                                                                                                          fs.createReadStream('archive.tar'),
                                                                                                                          zlib.createGzip(),
                                                                                                                          fs.createWriteStream('archive.tar.gz'),
                                                                                                                          (err) => {
                                                                                                                            if (err) {
                                                                                                                              console.error('Pipeline failed.', err);
                                                                                                                            } else {
                                                                                                                              console.log('Pipeline succeeded.');
                                                                                                                            }
                                                                                                                          },
                                                                                                                        );
                                                                                                                        @@ -122,8 +122,8 @@

                                                                                                                        Type Parameters

                                                                                                                        Parameters

                                                                                                                        • source: A
                                                                                                                        • transform1: T1
                                                                                                                        • transform2: T2
                                                                                                                        • transform3: T3
                                                                                                                        • transform4: T4
                                                                                                                        • destination: B
                                                                                                                        • callback: PipelineCallback<B>

                                                                                                                          Called when the pipeline is fully done.

                                                                                                                          -

                                                                                                                        Returns B extends WritableStream ? B<B> : WritableStream

                                                                                                                        v10.0.0

                                                                                                                        -

                                                                                                                      • A module method to pipe between streams and generators forwarding errors and +

                                                                                                                        • Returns B extends WritableStream ? B<B> : WritableStream

                                                                                                                        v10.0.0

                                                                                                                        +

                                                                                                                      • A module method to pipe between streams and generators forwarding errors and properly cleaning up and provide a callback when the pipeline is complete.

                                                                                                                        import { pipeline } from 'node:stream';
                                                                                                                        import fs from 'node:fs';
                                                                                                                        import zlib from 'node:zlib';

                                                                                                                        // Use the pipeline API to easily pipe a series of streams
                                                                                                                        // together and get notified when the pipeline is fully done.

                                                                                                                        // A pipeline to gzip a potentially huge tar file efficiently:

                                                                                                                        pipeline(
                                                                                                                          fs.createReadStream('archive.tar'),
                                                                                                                          zlib.createGzip(),
                                                                                                                          fs.createWriteStream('archive.tar.gz'),
                                                                                                                          (err) => {
                                                                                                                            if (err) {
                                                                                                                              console.error('Pipeline failed.', err);
                                                                                                                            } else {
                                                                                                                              console.log('Pipeline succeeded.');
                                                                                                                            }
                                                                                                                          },
                                                                                                                        );
                                                                                                                        @@ -147,8 +147,8 @@

                                                                                                                        Parameters

                                                                                                                        Returns WritableStream

                                                                                                                        v10.0.0

                                                                                                                        -

                                                                                                                      • A module method to pipe between streams and generators forwarding errors and +

                                                                                                                        • Returns WritableStream

                                                                                                                        v10.0.0

                                                                                                                        +

                                                                                                                      • A module method to pipe between streams and generators forwarding errors and properly cleaning up and provide a callback when the pipeline is complete.

                                                                                                                        import { pipeline } from 'node:stream';
                                                                                                                        import fs from 'node:fs';
                                                                                                                        import zlib from 'node:zlib';

                                                                                                                        // Use the pipeline API to easily pipe a series of streams
                                                                                                                        // together and get notified when the pipeline is fully done.

                                                                                                                        // A pipeline to gzip a potentially huge tar file efficiently:

                                                                                                                        pipeline(
                                                                                                                          fs.createReadStream('archive.tar'),
                                                                                                                          zlib.createGzip(),
                                                                                                                          fs.createWriteStream('archive.tar.gz'),
                                                                                                                          (err) => {
                                                                                                                            if (err) {
                                                                                                                              console.error('Pipeline failed.', err);
                                                                                                                            } else {
                                                                                                                              console.log('Pipeline succeeded.');
                                                                                                                            }
                                                                                                                          },
                                                                                                                        );
                                                                                                                        @@ -172,4 +172,4 @@

                                                                                                                        Parameters

                                                                                                                        Returns WritableStream

                                                                                                                        v10.0.0

                                                                                                                        -

                                                                                                                        • Settings

                                                                                                                        Member Visibility
                                                                                                                        +

                                                                                                                        Settings

                                                                                                                        Member Visibility
                                                                                                                        diff --git a/docs/functions/_internal_.Stream.setDefaultHighWaterMark.html b/docs/functions/_internal_.Stream.setDefaultHighWaterMark.html index 3fbe447e..1fd21648 100644 --- a/docs/functions/_internal_.Stream.setDefaultHighWaterMark.html +++ b/docs/functions/_internal_.Stream.setDefaultHighWaterMark.html @@ -1,4 +1,4 @@ setDefaultHighWaterMark | ts-lambda-api - v2.5.2
                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                          Preparing search index...

                                                                                                                          Function setDefaultHighWaterMark

                                                                                                                          • Sets the default highWaterMark used by streams.

                                                                                                                            Parameters

                                                                                                                            • objectMode: boolean
                                                                                                                            • value: number

                                                                                                                              highWaterMark value

                                                                                                                              -

                                                                                                                            Returns void

                                                                                                                            v19.9.0

                                                                                                                            -

                                                                                                                          Settings

                                                                                                                          Member Visibility
                                                                                                                          +

                                                                                                                          Returns void

                                                                                                                          v19.9.0

                                                                                                                          +

                                                                                                                          Settings

                                                                                                                          Member Visibility
                                                                                                                          diff --git a/docs/functions/_internal_._construct-1.html b/docs/functions/_internal_._construct-1.html deleted file mode 100644 index 6876f7cf..00000000 --- a/docs/functions/_internal_._construct-1.html +++ /dev/null @@ -1 +0,0 @@ -_construct | ts-lambda-api - v2.5.2
                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                            Preparing search index...

                                                                                                                            Function _constructOptional

                                                                                                                            • _construct(callback: (error?: Error) => void): void

                                                                                                                              Parameters

                                                                                                                              • callback: (error?: Error) => void

                                                                                                                              Returns void

                                                                                                                            Settings

                                                                                                                            Member Visibility
                                                                                                                            diff --git a/docs/functions/_internal_._construct.html b/docs/functions/_internal_._construct.html deleted file mode 100644 index 30b8fbc8..00000000 --- a/docs/functions/_internal_._construct.html +++ /dev/null @@ -1 +0,0 @@ -_construct | ts-lambda-api - v2.5.2
                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                              Preparing search index...

                                                                                                                              Function _constructOptional

                                                                                                                              • _construct(callback: (error?: Error) => void): void

                                                                                                                                Parameters

                                                                                                                                • callback: (error?: Error) => void

                                                                                                                                Returns void

                                                                                                                              Settings

                                                                                                                              Member Visibility
                                                                                                                              diff --git a/docs/functions/_internal_._destroy-1.html b/docs/functions/_internal_._destroy-1.html deleted file mode 100644 index 6339345b..00000000 --- a/docs/functions/_internal_._destroy-1.html +++ /dev/null @@ -1 +0,0 @@ -_destroy | ts-lambda-api - v2.5.2
                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                Preparing search index...

                                                                                                                                Function _destroy

                                                                                                                                • _destroy(error: Error, callback: (error?: Error) => void): void

                                                                                                                                  Parameters

                                                                                                                                  • error: Error
                                                                                                                                  • callback: (error?: Error) => void

                                                                                                                                  Returns void

                                                                                                                                Settings

                                                                                                                                Member Visibility
                                                                                                                                diff --git a/docs/functions/_internal_._destroy.html b/docs/functions/_internal_._destroy.html deleted file mode 100644 index 51128ea8..00000000 --- a/docs/functions/_internal_._destroy.html +++ /dev/null @@ -1 +0,0 @@ -_destroy | ts-lambda-api - v2.5.2
                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                  Preparing search index...

                                                                                                                                  Function _destroy

                                                                                                                                  • _destroy(error: Error, callback: (error?: Error) => void): void

                                                                                                                                    Parameters

                                                                                                                                    • error: Error
                                                                                                                                    • callback: (error?: Error) => void

                                                                                                                                    Returns void

                                                                                                                                  Settings

                                                                                                                                  Member Visibility
                                                                                                                                  diff --git a/docs/functions/_internal_._final.html b/docs/functions/_internal_._final.html deleted file mode 100644 index 9acdd73e..00000000 --- a/docs/functions/_internal_._final.html +++ /dev/null @@ -1 +0,0 @@ -_final | ts-lambda-api - v2.5.2
                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                    Preparing search index...

                                                                                                                                    Function _final

                                                                                                                                    • _final(callback: (error?: Error) => void): void

                                                                                                                                      Parameters

                                                                                                                                      • callback: (error?: Error) => void

                                                                                                                                      Returns void

                                                                                                                                    Settings

                                                                                                                                    Member Visibility
                                                                                                                                    diff --git a/docs/functions/_internal_._write.html b/docs/functions/_internal_._write.html deleted file mode 100644 index 76303a8f..00000000 --- a/docs/functions/_internal_._write.html +++ /dev/null @@ -1 +0,0 @@ -_write | ts-lambda-api - v2.5.2
                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                      Preparing search index...

                                                                                                                                      Function _write

                                                                                                                                      • _write(
                                                                                                                                            chunk: any,
                                                                                                                                            encoding: BufferEncoding,
                                                                                                                                            callback: (error?: Error) => void,
                                                                                                                                        ): void

                                                                                                                                        Parameters

                                                                                                                                        Returns void

                                                                                                                                      Settings

                                                                                                                                      Member Visibility
                                                                                                                                      diff --git a/docs/functions/_internal_._writev.html b/docs/functions/_internal_._writev.html deleted file mode 100644 index 37ba972c..00000000 --- a/docs/functions/_internal_._writev.html +++ /dev/null @@ -1 +0,0 @@ -_writev | ts-lambda-api - v2.5.2
                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                        Preparing search index...

                                                                                                                                        Function _writevOptional

                                                                                                                                        • _writev(
                                                                                                                                              chunks: { chunk: any; encoding: BufferEncoding }[],
                                                                                                                                              callback: (error?: Error) => void,
                                                                                                                                          ): void

                                                                                                                                          Parameters

                                                                                                                                          • chunks: { chunk: any; encoding: BufferEncoding }[]
                                                                                                                                          • callback: (error?: Error) => void

                                                                                                                                          Returns void

                                                                                                                                        Settings

                                                                                                                                        Member Visibility
                                                                                                                                        diff --git a/docs/functions/_internal_.add-1.html b/docs/functions/_internal_.add-1.html deleted file mode 100644 index 73d8a5ae..00000000 --- a/docs/functions/_internal_.add-1.html +++ /dev/null @@ -1,4 +0,0 @@ -add | ts-lambda-api - v2.5.2
                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                          Preparing search index...

                                                                                                                                          Function add

                                                                                                                                          • Adds a value to the collection.

                                                                                                                                            -

                                                                                                                                            Parameters

                                                                                                                                            • pair: Pair<K, V> | { key: K; value: V }
                                                                                                                                            • Optionaloverwrite: boolean

                                                                                                                                              If not set true, using a key that is already in the -collection will throw. Otherwise, overwrites the previous value.

                                                                                                                                              -

                                                                                                                                            Returns void

                                                                                                                                          Settings

                                                                                                                                          Member Visibility
                                                                                                                                          diff --git a/docs/functions/_internal_.add-2.html b/docs/functions/_internal_.add-2.html deleted file mode 100644 index be219921..00000000 --- a/docs/functions/_internal_.add-2.html +++ /dev/null @@ -1,2 +0,0 @@ -add | ts-lambda-api - v2.5.2
                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                            Preparing search index...

                                                                                                                                            Function add

                                                                                                                                            • Adds a value to the collection.

                                                                                                                                              -

                                                                                                                                              Parameters

                                                                                                                                              • value: T

                                                                                                                                              Returns void

                                                                                                                                            Settings

                                                                                                                                            Member Visibility
                                                                                                                                            diff --git a/docs/functions/_internal_.add.html b/docs/functions/_internal_.add.html deleted file mode 100644 index 8681d52e..00000000 --- a/docs/functions/_internal_.add.html +++ /dev/null @@ -1,2 +0,0 @@ -add | ts-lambda-api - v2.5.2
                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                              Preparing search index...

                                                                                                                                              Function add

                                                                                                                                              • Adds a value to the document.

                                                                                                                                                -

                                                                                                                                                Parameters

                                                                                                                                                • value: any

                                                                                                                                                Returns void

                                                                                                                                              Settings

                                                                                                                                              Member Visibility
                                                                                                                                              diff --git a/docs/functions/_internal_.addIn.html b/docs/functions/_internal_.addIn.html deleted file mode 100644 index 4960514b..00000000 --- a/docs/functions/_internal_.addIn.html +++ /dev/null @@ -1,2 +0,0 @@ -addIn | ts-lambda-api - v2.5.2
                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                Preparing search index...

                                                                                                                                                Function addIn

                                                                                                                                                • Adds a value to the document.

                                                                                                                                                  -

                                                                                                                                                  Parameters

                                                                                                                                                  Returns void

                                                                                                                                                Settings

                                                                                                                                                Member Visibility
                                                                                                                                                diff --git a/docs/functions/_internal_.addListener-1.html b/docs/functions/_internal_.addListener-1.html deleted file mode 100644 index 87426fbe..00000000 --- a/docs/functions/_internal_.addListener-1.html +++ /dev/null @@ -1,181 +0,0 @@ -addListener | ts-lambda-api - v2.5.2
                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                  Preparing search index...

                                                                                                                                                  Function addListener

                                                                                                                                                  • Event emitter -The defined events on documents including:

                                                                                                                                                    -
                                                                                                                                                      -
                                                                                                                                                    1. close
                                                                                                                                                      2. -
                                                                                                                                                    2. data
                                                                                                                                                      3. -
                                                                                                                                                    3. drain
                                                                                                                                                      4. -
                                                                                                                                                    4. end
                                                                                                                                                      5. -
                                                                                                                                                    5. error
                                                                                                                                                      6. -
                                                                                                                                                    6. finish
                                                                                                                                                      7. -
                                                                                                                                                    7. pause
                                                                                                                                                      8. -
                                                                                                                                                    8. pipe
                                                                                                                                                      9. -
                                                                                                                                                    9. readable
                                                                                                                                                      10. -
                                                                                                                                                    10. resume
                                                                                                                                                      11. -
                                                                                                                                                    11. unpipe
                                                                                                                                                      12. -
                                                                                                                                                    -

                                                                                                                                                    Parameters

                                                                                                                                                    • event: "close"
                                                                                                                                                    • listener: () => void

                                                                                                                                                    Returns this

                                                                                                                                                  • Event emitter -The defined events on documents including:

                                                                                                                                                    -
                                                                                                                                                      -
                                                                                                                                                    1. close
                                                                                                                                                      2. -
                                                                                                                                                    2. data
                                                                                                                                                      3. -
                                                                                                                                                    3. drain
                                                                                                                                                      4. -
                                                                                                                                                    4. end
                                                                                                                                                      5. -
                                                                                                                                                    5. error
                                                                                                                                                      6. -
                                                                                                                                                    6. finish
                                                                                                                                                      7. -
                                                                                                                                                    7. pause
                                                                                                                                                      8. -
                                                                                                                                                    8. pipe
                                                                                                                                                      9. -
                                                                                                                                                    9. readable
                                                                                                                                                      10. -
                                                                                                                                                    10. resume
                                                                                                                                                      11. -
                                                                                                                                                    11. unpipe
                                                                                                                                                      12. -
                                                                                                                                                    -

                                                                                                                                                    Parameters

                                                                                                                                                    • event: "data"
                                                                                                                                                    • listener: (chunk: any) => void

                                                                                                                                                    Returns this

                                                                                                                                                  • Event emitter -The defined events on documents including:

                                                                                                                                                    -
                                                                                                                                                      -
                                                                                                                                                    1. close
                                                                                                                                                      2. -
                                                                                                                                                    2. data
                                                                                                                                                      3. -
                                                                                                                                                    3. drain
                                                                                                                                                      4. -
                                                                                                                                                    4. end
                                                                                                                                                      5. -
                                                                                                                                                    5. error
                                                                                                                                                      6. -
                                                                                                                                                    6. finish
                                                                                                                                                      7. -
                                                                                                                                                    7. pause
                                                                                                                                                      8. -
                                                                                                                                                    8. pipe
                                                                                                                                                      9. -
                                                                                                                                                    9. readable
                                                                                                                                                      10. -
                                                                                                                                                    10. resume
                                                                                                                                                      11. -
                                                                                                                                                    11. unpipe
                                                                                                                                                      12. -
                                                                                                                                                    -

                                                                                                                                                    Parameters

                                                                                                                                                    • event: "drain"
                                                                                                                                                    • listener: () => void

                                                                                                                                                    Returns this

                                                                                                                                                  • Event emitter -The defined events on documents including:

                                                                                                                                                    -
                                                                                                                                                      -
                                                                                                                                                    1. close
                                                                                                                                                      2. -
                                                                                                                                                    2. data
                                                                                                                                                      3. -
                                                                                                                                                    3. drain
                                                                                                                                                      4. -
                                                                                                                                                    4. end
                                                                                                                                                      5. -
                                                                                                                                                    5. error
                                                                                                                                                      6. -
                                                                                                                                                    6. finish
                                                                                                                                                      7. -
                                                                                                                                                    7. pause
                                                                                                                                                      8. -
                                                                                                                                                    8. pipe
                                                                                                                                                      9. -
                                                                                                                                                    9. readable
                                                                                                                                                      10. -
                                                                                                                                                    10. resume
                                                                                                                                                      11. -
                                                                                                                                                    11. unpipe
                                                                                                                                                      12. -
                                                                                                                                                    -

                                                                                                                                                    Parameters

                                                                                                                                                    • event: "end"
                                                                                                                                                    • listener: () => void

                                                                                                                                                    Returns this

                                                                                                                                                  • Event emitter -The defined events on documents including:

                                                                                                                                                    -
                                                                                                                                                      -
                                                                                                                                                    1. close
                                                                                                                                                      2. -
                                                                                                                                                    2. data
                                                                                                                                                      3. -
                                                                                                                                                    3. drain
                                                                                                                                                      4. -
                                                                                                                                                    4. end
                                                                                                                                                      5. -
                                                                                                                                                    5. error
                                                                                                                                                      6. -
                                                                                                                                                    6. finish
                                                                                                                                                      7. -
                                                                                                                                                    7. pause
                                                                                                                                                      8. -
                                                                                                                                                    8. pipe
                                                                                                                                                      9. -
                                                                                                                                                    9. readable
                                                                                                                                                      10. -
                                                                                                                                                    10. resume
                                                                                                                                                      11. -
                                                                                                                                                    11. unpipe
                                                                                                                                                      12. -
                                                                                                                                                    -

                                                                                                                                                    Parameters

                                                                                                                                                    • event: "error"
                                                                                                                                                    • listener: (err: Error) => void

                                                                                                                                                    Returns this

                                                                                                                                                  • Event emitter -The defined events on documents including:

                                                                                                                                                    -
                                                                                                                                                      -
                                                                                                                                                    1. close
                                                                                                                                                      2. -
                                                                                                                                                    2. data
                                                                                                                                                      3. -
                                                                                                                                                    3. drain
                                                                                                                                                      4. -
                                                                                                                                                    4. end
                                                                                                                                                      5. -
                                                                                                                                                    5. error
                                                                                                                                                      6. -
                                                                                                                                                    6. finish
                                                                                                                                                      7. -
                                                                                                                                                    7. pause
                                                                                                                                                      8. -
                                                                                                                                                    8. pipe
                                                                                                                                                      9. -
                                                                                                                                                    9. readable
                                                                                                                                                      10. -
                                                                                                                                                    10. resume
                                                                                                                                                      11. -
                                                                                                                                                    11. unpipe
                                                                                                                                                      12. -
                                                                                                                                                    -

                                                                                                                                                    Parameters

                                                                                                                                                    • event: "finish"
                                                                                                                                                    • listener: () => void

                                                                                                                                                    Returns this

                                                                                                                                                  • Event emitter -The defined events on documents including:

                                                                                                                                                    -
                                                                                                                                                      -
                                                                                                                                                    1. close
                                                                                                                                                      2. -
                                                                                                                                                    2. data
                                                                                                                                                      3. -
                                                                                                                                                    3. drain
                                                                                                                                                      4. -
                                                                                                                                                    4. end
                                                                                                                                                      5. -
                                                                                                                                                    5. error
                                                                                                                                                      6. -
                                                                                                                                                    6. finish
                                                                                                                                                      7. -
                                                                                                                                                    7. pause
                                                                                                                                                      8. -
                                                                                                                                                    8. pipe
                                                                                                                                                      9. -
                                                                                                                                                    9. readable
                                                                                                                                                      10. -
                                                                                                                                                    10. resume
                                                                                                                                                      11. -
                                                                                                                                                    11. unpipe
                                                                                                                                                      12. -
                                                                                                                                                    -

                                                                                                                                                    Parameters

                                                                                                                                                    • event: "pause"
                                                                                                                                                    • listener: () => void

                                                                                                                                                    Returns this

                                                                                                                                                  • Event emitter -The defined events on documents including:

                                                                                                                                                    -
                                                                                                                                                      -
                                                                                                                                                    1. close
                                                                                                                                                      2. -
                                                                                                                                                    2. data
                                                                                                                                                      3. -
                                                                                                                                                    3. drain
                                                                                                                                                      4. -
                                                                                                                                                    4. end
                                                                                                                                                      5. -
                                                                                                                                                    5. error
                                                                                                                                                      6. -
                                                                                                                                                    6. finish
                                                                                                                                                      7. -
                                                                                                                                                    7. pause
                                                                                                                                                      8. -
                                                                                                                                                    8. pipe
                                                                                                                                                      9. -
                                                                                                                                                    9. readable
                                                                                                                                                      10. -
                                                                                                                                                    10. resume
                                                                                                                                                      11. -
                                                                                                                                                    11. unpipe
                                                                                                                                                      12. -
                                                                                                                                                    -

                                                                                                                                                    Parameters

                                                                                                                                                    • event: "pipe"
                                                                                                                                                    • listener: (src: Readable) => void

                                                                                                                                                    Returns this

                                                                                                                                                  • Event emitter -The defined events on documents including:

                                                                                                                                                    -
                                                                                                                                                      -
                                                                                                                                                    1. close
                                                                                                                                                      2. -
                                                                                                                                                    2. data
                                                                                                                                                      3. -
                                                                                                                                                    3. drain
                                                                                                                                                      4. -
                                                                                                                                                    4. end
                                                                                                                                                      5. -
                                                                                                                                                    5. error
                                                                                                                                                      6. -
                                                                                                                                                    6. finish
                                                                                                                                                      7. -
                                                                                                                                                    7. pause
                                                                                                                                                      8. -
                                                                                                                                                    8. pipe
                                                                                                                                                      9. -
                                                                                                                                                    9. readable
                                                                                                                                                      10. -
                                                                                                                                                    10. resume
                                                                                                                                                      11. -
                                                                                                                                                    11. unpipe
                                                                                                                                                      12. -
                                                                                                                                                    -

                                                                                                                                                    Parameters

                                                                                                                                                    • event: "readable"
                                                                                                                                                    • listener: () => void

                                                                                                                                                    Returns this

                                                                                                                                                  • Event emitter -The defined events on documents including:

                                                                                                                                                    -
                                                                                                                                                      -
                                                                                                                                                    1. close
                                                                                                                                                      2. -
                                                                                                                                                    2. data
                                                                                                                                                      3. -
                                                                                                                                                    3. drain
                                                                                                                                                      4. -
                                                                                                                                                    4. end
                                                                                                                                                      5. -
                                                                                                                                                    5. error
                                                                                                                                                      6. -
                                                                                                                                                    6. finish
                                                                                                                                                      7. -
                                                                                                                                                    7. pause
                                                                                                                                                      8. -
                                                                                                                                                    8. pipe
                                                                                                                                                      9. -
                                                                                                                                                    9. readable
                                                                                                                                                      10. -
                                                                                                                                                    10. resume
                                                                                                                                                      11. -
                                                                                                                                                    11. unpipe
                                                                                                                                                      12. -
                                                                                                                                                    -

                                                                                                                                                    Parameters

                                                                                                                                                    • event: "resume"
                                                                                                                                                    • listener: () => void

                                                                                                                                                    Returns this

                                                                                                                                                  • Event emitter -The defined events on documents including:

                                                                                                                                                    -
                                                                                                                                                      -
                                                                                                                                                    1. close
                                                                                                                                                      2. -
                                                                                                                                                    2. data
                                                                                                                                                      3. -
                                                                                                                                                    3. drain
                                                                                                                                                      4. -
                                                                                                                                                    4. end
                                                                                                                                                      5. -
                                                                                                                                                    5. error
                                                                                                                                                      6. -
                                                                                                                                                    6. finish
                                                                                                                                                      7. -
                                                                                                                                                    7. pause
                                                                                                                                                      8. -
                                                                                                                                                    8. pipe
                                                                                                                                                      9. -
                                                                                                                                                    9. readable
                                                                                                                                                      10. -
                                                                                                                                                    10. resume
                                                                                                                                                      11. -
                                                                                                                                                    11. unpipe
                                                                                                                                                      12. -
                                                                                                                                                    -

                                                                                                                                                    Parameters

                                                                                                                                                    • event: "unpipe"
                                                                                                                                                    • listener: (src: Readable) => void

                                                                                                                                                    Returns this

                                                                                                                                                  • Event emitter -The defined events on documents including:

                                                                                                                                                    -
                                                                                                                                                      -
                                                                                                                                                    1. close
                                                                                                                                                      2. -
                                                                                                                                                    2. data
                                                                                                                                                      3. -
                                                                                                                                                    3. drain
                                                                                                                                                      4. -
                                                                                                                                                    4. end
                                                                                                                                                      5. -
                                                                                                                                                    5. error
                                                                                                                                                      6. -
                                                                                                                                                    6. finish
                                                                                                                                                      7. -
                                                                                                                                                    7. pause
                                                                                                                                                      8. -
                                                                                                                                                    8. pipe
                                                                                                                                                      9. -
                                                                                                                                                    9. readable
                                                                                                                                                      10. -
                                                                                                                                                    10. resume
                                                                                                                                                      11. -
                                                                                                                                                    11. unpipe
                                                                                                                                                      12. -
                                                                                                                                                    -

                                                                                                                                                    Parameters

                                                                                                                                                    • event: string | symbol
                                                                                                                                                    • listener: (...args: any[]) => void

                                                                                                                                                    Returns this

                                                                                                                                                  Settings

                                                                                                                                                  Member Visibility
                                                                                                                                                  diff --git a/docs/functions/_internal_.addListener-2.html b/docs/functions/_internal_.addListener-2.html deleted file mode 100644 index cb86e865..00000000 --- a/docs/functions/_internal_.addListener-2.html +++ /dev/null @@ -1,89 +0,0 @@ -addListener | ts-lambda-api - v2.5.2
                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                    Preparing search index...

                                                                                                                                                    Function addListener

                                                                                                                                                    • Event emitter -The defined events on documents including:

                                                                                                                                                      -
                                                                                                                                                        -
                                                                                                                                                      1. close
                                                                                                                                                        2. -
                                                                                                                                                      2. data
                                                                                                                                                        3. -
                                                                                                                                                      3. end
                                                                                                                                                        4. -
                                                                                                                                                      4. error
                                                                                                                                                        5. -
                                                                                                                                                      5. pause
                                                                                                                                                        6. -
                                                                                                                                                      6. readable
                                                                                                                                                        7. -
                                                                                                                                                      7. resume
                                                                                                                                                        8. -
                                                                                                                                                      -

                                                                                                                                                      Parameters

                                                                                                                                                      • event: "close"
                                                                                                                                                      • listener: () => void

                                                                                                                                                      Returns this

                                                                                                                                                    • Event emitter -The defined events on documents including:

                                                                                                                                                      -
                                                                                                                                                        -
                                                                                                                                                      1. close
                                                                                                                                                        2. -
                                                                                                                                                      2. data
                                                                                                                                                        3. -
                                                                                                                                                      3. end
                                                                                                                                                        4. -
                                                                                                                                                      4. error
                                                                                                                                                        5. -
                                                                                                                                                      5. pause
                                                                                                                                                        6. -
                                                                                                                                                      6. readable
                                                                                                                                                        7. -
                                                                                                                                                      7. resume
                                                                                                                                                        8. -
                                                                                                                                                      -

                                                                                                                                                      Parameters

                                                                                                                                                      • event: "data"
                                                                                                                                                      • listener: (chunk: any) => void

                                                                                                                                                      Returns this

                                                                                                                                                    • Event emitter -The defined events on documents including:

                                                                                                                                                      -
                                                                                                                                                        -
                                                                                                                                                      1. close
                                                                                                                                                        2. -
                                                                                                                                                      2. data
                                                                                                                                                        3. -
                                                                                                                                                      3. end
                                                                                                                                                        4. -
                                                                                                                                                      4. error
                                                                                                                                                        5. -
                                                                                                                                                      5. pause
                                                                                                                                                        6. -
                                                                                                                                                      6. readable
                                                                                                                                                        7. -
                                                                                                                                                      7. resume
                                                                                                                                                        8. -
                                                                                                                                                      -

                                                                                                                                                      Parameters

                                                                                                                                                      • event: "end"
                                                                                                                                                      • listener: () => void

                                                                                                                                                      Returns this

                                                                                                                                                    • Event emitter -The defined events on documents including:

                                                                                                                                                      -
                                                                                                                                                        -
                                                                                                                                                      1. close
                                                                                                                                                        2. -
                                                                                                                                                      2. data
                                                                                                                                                        3. -
                                                                                                                                                      3. end
                                                                                                                                                        4. -
                                                                                                                                                      4. error
                                                                                                                                                        5. -
                                                                                                                                                      5. pause
                                                                                                                                                        6. -
                                                                                                                                                      6. readable
                                                                                                                                                        7. -
                                                                                                                                                      7. resume
                                                                                                                                                        8. -
                                                                                                                                                      -

                                                                                                                                                      Parameters

                                                                                                                                                      • event: "error"
                                                                                                                                                      • listener: (err: Error) => void

                                                                                                                                                      Returns this

                                                                                                                                                    • Event emitter -The defined events on documents including:

                                                                                                                                                      -
                                                                                                                                                        -
                                                                                                                                                      1. close
                                                                                                                                                        2. -
                                                                                                                                                      2. data
                                                                                                                                                        3. -
                                                                                                                                                      3. end
                                                                                                                                                        4. -
                                                                                                                                                      4. error
                                                                                                                                                        5. -
                                                                                                                                                      5. pause
                                                                                                                                                        6. -
                                                                                                                                                      6. readable
                                                                                                                                                        7. -
                                                                                                                                                      7. resume
                                                                                                                                                        8. -
                                                                                                                                                      -

                                                                                                                                                      Parameters

                                                                                                                                                      • event: "pause"
                                                                                                                                                      • listener: () => void

                                                                                                                                                      Returns this

                                                                                                                                                    • Event emitter -The defined events on documents including:

                                                                                                                                                      -
                                                                                                                                                        -
                                                                                                                                                      1. close
                                                                                                                                                        2. -
                                                                                                                                                      2. data
                                                                                                                                                        3. -
                                                                                                                                                      3. end
                                                                                                                                                        4. -
                                                                                                                                                      4. error
                                                                                                                                                        5. -
                                                                                                                                                      5. pause
                                                                                                                                                        6. -
                                                                                                                                                      6. readable
                                                                                                                                                        7. -
                                                                                                                                                      7. resume
                                                                                                                                                        8. -
                                                                                                                                                      -

                                                                                                                                                      Parameters

                                                                                                                                                      • event: "readable"
                                                                                                                                                      • listener: () => void

                                                                                                                                                      Returns this

                                                                                                                                                    • Event emitter -The defined events on documents including:

                                                                                                                                                      -
                                                                                                                                                        -
                                                                                                                                                      1. close
                                                                                                                                                        2. -
                                                                                                                                                      2. data
                                                                                                                                                        3. -
                                                                                                                                                      3. end
                                                                                                                                                        4. -
                                                                                                                                                      4. error
                                                                                                                                                        5. -
                                                                                                                                                      5. pause
                                                                                                                                                        6. -
                                                                                                                                                      6. readable
                                                                                                                                                        7. -
                                                                                                                                                      7. resume
                                                                                                                                                        8. -
                                                                                                                                                      -

                                                                                                                                                      Parameters

                                                                                                                                                      • event: "resume"
                                                                                                                                                      • listener: () => void

                                                                                                                                                      Returns this

                                                                                                                                                    • Event emitter -The defined events on documents including:

                                                                                                                                                      -
                                                                                                                                                        -
                                                                                                                                                      1. close
                                                                                                                                                        2. -
                                                                                                                                                      2. data
                                                                                                                                                        3. -
                                                                                                                                                      3. end
                                                                                                                                                        4. -
                                                                                                                                                      4. error
                                                                                                                                                        5. -
                                                                                                                                                      5. pause
                                                                                                                                                        6. -
                                                                                                                                                      6. readable
                                                                                                                                                        7. -
                                                                                                                                                      7. resume
                                                                                                                                                        8. -
                                                                                                                                                      -

                                                                                                                                                      Parameters

                                                                                                                                                      • event: string | symbol
                                                                                                                                                      • listener: (...args: any[]) => void

                                                                                                                                                      Returns this

                                                                                                                                                    Settings

                                                                                                                                                    Member Visibility
                                                                                                                                                    diff --git a/docs/functions/_internal_.addListener-3.html b/docs/functions/_internal_.addListener-3.html deleted file mode 100644 index 319d306e..00000000 --- a/docs/functions/_internal_.addListener-3.html +++ /dev/null @@ -1,71 +0,0 @@ -addListener | ts-lambda-api - v2.5.2
                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                      Preparing search index...

                                                                                                                                                      Function addListener

                                                                                                                                                      • Event emitter -The defined events on documents including:

                                                                                                                                                        -
                                                                                                                                                          -
                                                                                                                                                        1. close
                                                                                                                                                          2. -
                                                                                                                                                        2. drain
                                                                                                                                                          3. -
                                                                                                                                                        3. error
                                                                                                                                                          4. -
                                                                                                                                                        4. finish
                                                                                                                                                          5. -
                                                                                                                                                        5. pipe
                                                                                                                                                          6. -
                                                                                                                                                        6. unpipe
                                                                                                                                                          7. -
                                                                                                                                                        -

                                                                                                                                                        Parameters

                                                                                                                                                        • event: "close"
                                                                                                                                                        • listener: () => void

                                                                                                                                                        Returns this

                                                                                                                                                      • Event emitter -The defined events on documents including:

                                                                                                                                                        -
                                                                                                                                                          -
                                                                                                                                                        1. close
                                                                                                                                                          2. -
                                                                                                                                                        2. drain
                                                                                                                                                          3. -
                                                                                                                                                        3. error
                                                                                                                                                          4. -
                                                                                                                                                        4. finish
                                                                                                                                                          5. -
                                                                                                                                                        5. pipe
                                                                                                                                                          6. -
                                                                                                                                                        6. unpipe
                                                                                                                                                          7. -
                                                                                                                                                        -

                                                                                                                                                        Parameters

                                                                                                                                                        • event: "drain"
                                                                                                                                                        • listener: () => void

                                                                                                                                                        Returns this

                                                                                                                                                      • Event emitter -The defined events on documents including:

                                                                                                                                                        -
                                                                                                                                                          -
                                                                                                                                                        1. close
                                                                                                                                                          2. -
                                                                                                                                                        2. drain
                                                                                                                                                          3. -
                                                                                                                                                        3. error
                                                                                                                                                          4. -
                                                                                                                                                        4. finish
                                                                                                                                                          5. -
                                                                                                                                                        5. pipe
                                                                                                                                                          6. -
                                                                                                                                                        6. unpipe
                                                                                                                                                          7. -
                                                                                                                                                        -

                                                                                                                                                        Parameters

                                                                                                                                                        • event: "error"
                                                                                                                                                        • listener: (err: Error) => void

                                                                                                                                                        Returns this

                                                                                                                                                      • Event emitter -The defined events on documents including:

                                                                                                                                                        -
                                                                                                                                                          -
                                                                                                                                                        1. close
                                                                                                                                                          2. -
                                                                                                                                                        2. drain
                                                                                                                                                          3. -
                                                                                                                                                        3. error
                                                                                                                                                          4. -
                                                                                                                                                        4. finish
                                                                                                                                                          5. -
                                                                                                                                                        5. pipe
                                                                                                                                                          6. -
                                                                                                                                                        6. unpipe
                                                                                                                                                          7. -
                                                                                                                                                        -

                                                                                                                                                        Parameters

                                                                                                                                                        • event: "finish"
                                                                                                                                                        • listener: () => void

                                                                                                                                                        Returns this

                                                                                                                                                      • Event emitter -The defined events on documents including:

                                                                                                                                                        -
                                                                                                                                                          -
                                                                                                                                                        1. close
                                                                                                                                                          2. -
                                                                                                                                                        2. drain
                                                                                                                                                          3. -
                                                                                                                                                        3. error
                                                                                                                                                          4. -
                                                                                                                                                        4. finish
                                                                                                                                                          5. -
                                                                                                                                                        5. pipe
                                                                                                                                                          6. -
                                                                                                                                                        6. unpipe
                                                                                                                                                          7. -
                                                                                                                                                        -

                                                                                                                                                        Parameters

                                                                                                                                                        • event: "pipe"
                                                                                                                                                        • listener: (src: Readable) => void

                                                                                                                                                        Returns this

                                                                                                                                                      • Event emitter -The defined events on documents including:

                                                                                                                                                        -
                                                                                                                                                          -
                                                                                                                                                        1. close
                                                                                                                                                          2. -
                                                                                                                                                        2. drain
                                                                                                                                                          3. -
                                                                                                                                                        3. error
                                                                                                                                                          4. -
                                                                                                                                                        4. finish
                                                                                                                                                          5. -
                                                                                                                                                        5. pipe
                                                                                                                                                          6. -
                                                                                                                                                        6. unpipe
                                                                                                                                                          7. -
                                                                                                                                                        -

                                                                                                                                                        Parameters

                                                                                                                                                        • event: "unpipe"
                                                                                                                                                        • listener: (src: Readable) => void

                                                                                                                                                        Returns this

                                                                                                                                                      • Event emitter -The defined events on documents including:

                                                                                                                                                        -
                                                                                                                                                          -
                                                                                                                                                        1. close
                                                                                                                                                          2. -
                                                                                                                                                        2. drain
                                                                                                                                                          3. -
                                                                                                                                                        3. error
                                                                                                                                                          4. -
                                                                                                                                                        4. finish
                                                                                                                                                          5. -
                                                                                                                                                        5. pipe
                                                                                                                                                          6. -
                                                                                                                                                        6. unpipe
                                                                                                                                                          7. -
                                                                                                                                                        -

                                                                                                                                                        Parameters

                                                                                                                                                        • event: string | symbol
                                                                                                                                                        • listener: (...args: any[]) => void

                                                                                                                                                        Returns this

                                                                                                                                                      Settings

                                                                                                                                                      Member Visibility
                                                                                                                                                      diff --git a/docs/functions/_internal_.addListener.html b/docs/functions/_internal_.addListener.html deleted file mode 100644 index e5339a1f..00000000 --- a/docs/functions/_internal_.addListener.html +++ /dev/null @@ -1,3 +0,0 @@ -addListener | ts-lambda-api - v2.5.2
                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                        Preparing search index...

                                                                                                                                                        Function addListener

                                                                                                                                                        • Alias for emitter.on(eventName, listener).

                                                                                                                                                          -

                                                                                                                                                          Type Parameters

                                                                                                                                                          • K

                                                                                                                                                          Parameters

                                                                                                                                                          Returns this

                                                                                                                                                          v0.1.26

                                                                                                                                                          -

                                                                                                                                                        Settings

                                                                                                                                                        Member Visibility
                                                                                                                                                        diff --git a/docs/functions/_internal_.addTrailers.html b/docs/functions/_internal_.addTrailers.html deleted file mode 100644 index 731b4ae6..00000000 --- a/docs/functions/_internal_.addTrailers.html +++ /dev/null @@ -1,12 +0,0 @@ -addTrailers | ts-lambda-api - v2.5.2
                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                          Preparing search index...

                                                                                                                                                          Function addTrailers

                                                                                                                                                          • Adds HTTP trailers (headers but at the end of the message) to the message.

                                                                                                                                                            -

                                                                                                                                                            Trailers will only be emitted if the message is chunked encoded. If not, -the trailers will be silently discarded.

                                                                                                                                                            -

                                                                                                                                                            HTTP requires the Trailer header to be sent to emit trailers, -with a list of header field names in its value, e.g.

                                                                                                                                                            -
                                                                                                                                                            message.writeHead(200, { 'Content-Type': 'text/plain',
                                                                                                                                                                                     'Trailer': 'Content-MD5' });
                                                                                                                                                            message.write(fileData);
                                                                                                                                                            message.addTrailers({ 'Content-MD5': '7895bf4b8828b55ceaf47747b4bca667' });
                                                                                                                                                            message.end();
-
                                                                                                                                                            - -

                                                                                                                                                            Attempting to set a header field name or value that contains invalid characters -will result in a TypeError being thrown.

                                                                                                                                                            -

                                                                                                                                                            Parameters

                                                                                                                                                            Returns void

                                                                                                                                                            v0.3.0

                                                                                                                                                            -

                                                                                                                                                          Settings

                                                                                                                                                          Member Visibility
                                                                                                                                                          diff --git a/docs/functions/_internal_.appendHeader.html b/docs/functions/_internal_.appendHeader.html deleted file mode 100644 index 5409e3b0..00000000 --- a/docs/functions/_internal_.appendHeader.html +++ /dev/null @@ -1,11 +0,0 @@ -appendHeader | ts-lambda-api - v2.5.2
                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                            Preparing search index...

                                                                                                                                                            Function appendHeader

                                                                                                                                                            • Append a single header value to the header object.

                                                                                                                                                              -

                                                                                                                                                              If the value is an array, this is equivalent to calling this method multiple -times.

                                                                                                                                                              -

                                                                                                                                                              If there were no previous values for the header, this is equivalent to calling outgoingMessage.setHeader(name, value).

                                                                                                                                                              -

                                                                                                                                                              Depending of the value of options.uniqueHeaders when the client request or the -server were created, this will end up in the header being sent multiple times or -a single time with values joined using ; .

                                                                                                                                                              -

                                                                                                                                                              Parameters

                                                                                                                                                              • name: string

                                                                                                                                                                Header name

                                                                                                                                                                -
                                                                                                                                                              • value: string | readonly string[]

                                                                                                                                                                Header value

                                                                                                                                                                -

                                                                                                                                                              Returns this

                                                                                                                                                              v18.3.0, v16.17.0

                                                                                                                                                              -

                                                                                                                                                            Settings

                                                                                                                                                            Member Visibility
                                                                                                                                                            diff --git a/docs/functions/_internal_.authenticate.html b/docs/functions/_internal_.authenticate.html deleted file mode 100644 index 951f32ec..00000000 --- a/docs/functions/_internal_.authenticate.html +++ /dev/null @@ -1,6 +0,0 @@ -authenticate | ts-lambda-api - v2.5.2
                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                              Preparing search index...

                                                                                                                                                              Function authenticate

                                                                                                                                                              • Attempt to authorise a user suing the authentication data supplied. -An instance of the principal type U should be returned on authentication -success, otherwise undefined should be returned.

                                                                                                                                                                -

                                                                                                                                                                Parameters

                                                                                                                                                                • authData: T

                                                                                                                                                                  An instance of the authentication data type T.

                                                                                                                                                                  -

                                                                                                                                                                Returns Promise<U>

                                                                                                                                                                Instance of type U or undefined on authentication failure.

                                                                                                                                                                -

                                                                                                                                                              Settings

                                                                                                                                                              Member Visibility
                                                                                                                                                              diff --git a/docs/functions/_internal_.bind.html b/docs/functions/_internal_.bind.html deleted file mode 100644 index 5f64e9d1..00000000 --- a/docs/functions/_internal_.bind.html +++ /dev/null @@ -1,4 +0,0 @@ -bind | ts-lambda-api - v2.5.2
                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                Preparing search index...

                                                                                                                                                                Function bind

                                                                                                                                                                • Binds the given function to execute to this AsyncResource's scope.

                                                                                                                                                                  -

                                                                                                                                                                  Type Parameters

                                                                                                                                                                  • Func extends (...args: any[]) => any

                                                                                                                                                                  Parameters

                                                                                                                                                                  • fn: Func

                                                                                                                                                                    The function to bind to the current AsyncResource.

                                                                                                                                                                    -

                                                                                                                                                                  Returns Func

                                                                                                                                                                  v14.8.0, v12.19.0

                                                                                                                                                                  -

                                                                                                                                                                Settings

                                                                                                                                                                Member Visibility
                                                                                                                                                                diff --git a/docs/functions/_internal_.clone.html b/docs/functions/_internal_.clone.html deleted file mode 100644 index c466db09..00000000 --- a/docs/functions/_internal_.clone.html +++ /dev/null @@ -1,3 +0,0 @@ -clone | ts-lambda-api - v2.5.2
                                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                                  Preparing search index...

                                                                                                                                                                  Function clone

                                                                                                                                                                  • Create a deep copy of this Document and its contents.

                                                                                                                                                                    -

                                                                                                                                                                    Custom Node values that inherit from Object still refer to their original instances.

                                                                                                                                                                    -

                                                                                                                                                                    Returns Document<Contents, Strict>

                                                                                                                                                                  Settings

                                                                                                                                                                  Member Visibility
                                                                                                                                                                  diff --git a/docs/functions/_internal_.compose.html b/docs/functions/_internal_.compose.html deleted file mode 100644 index 82a8fa0c..00000000 --- a/docs/functions/_internal_.compose.html +++ /dev/null @@ -1 +0,0 @@ -compose | ts-lambda-api - v2.5.2
                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                    Preparing search index...

                                                                                                                                                                    Function compose

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility
                                                                                                                                                                    diff --git a/docs/functions/_internal_.configureApi.html b/docs/functions/_internal_.configureApi.html deleted file mode 100644 index 1b51f2a4..00000000 --- a/docs/functions/_internal_.configureApi.html +++ /dev/null @@ -1,3 +0,0 @@ -configureApi | ts-lambda-api - v2.5.2
                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                      Preparing search index...

                                                                                                                                                                      Function configureApi

                                                                                                                                                                      • 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

                                                                                                                                                                      Settings

                                                                                                                                                                      Member Visibility
                                                                                                                                                                      diff --git a/docs/functions/_internal_.configureApp.html b/docs/functions/_internal_.configureApp.html deleted file mode 100644 index be2b45f9..00000000 --- a/docs/functions/_internal_.configureApp.html +++ /dev/null @@ -1,3 +0,0 @@ -configureApp | ts-lambda-api - v2.5.2
                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                        Preparing search index...

                                                                                                                                                                        Function configureApp

                                                                                                                                                                        • 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
                                                                                                                                                                        diff --git a/docs/functions/_internal_.construct.html b/docs/functions/_internal_.construct.html deleted file mode 100644 index a04895d3..00000000 --- a/docs/functions/_internal_.construct.html +++ /dev/null @@ -1 +0,0 @@ -construct | ts-lambda-api - v2.5.2
                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                          Preparing search index...

                                                                                                                                                                          Function constructOptional

                                                                                                                                                                          • Parameters

                                                                                                                                                                            • this: T
                                                                                                                                                                            • callback: (error?: Error) => void

                                                                                                                                                                            Returns void

                                                                                                                                                                          Settings

                                                                                                                                                                          Member Visibility
                                                                                                                                                                          diff --git a/docs/functions/_internal_.createAlias.html b/docs/functions/_internal_.createAlias.html deleted file mode 100644 index c43ce486..00000000 --- a/docs/functions/_internal_.createAlias.html +++ /dev/null @@ -1,7 +0,0 @@ -createAlias | ts-lambda-api - v2.5.2
                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                            Preparing search index...

                                                                                                                                                                            Function createAlias

                                                                                                                                                                            • Create a new Alias node, ensuring that the target node has the required anchor.

                                                                                                                                                                              -

                                                                                                                                                                              If node already has an anchor, name is ignored. -Otherwise, the node.anchor value will be set to name, -or if an anchor with that name is already present in the document, -name will be used as a prefix for a new unique anchor. -If name is undefined, the generated anchor will use 'a' as a prefix.

                                                                                                                                                                              -

                                                                                                                                                                              Parameters

                                                                                                                                                                              • node: Strict extends true
                                                                                                                                                                                    ? Scalar<unknown>
                                                                                                                                                                                    | YAMLMap<unknown, unknown>
                                                                                                                                                                                    | YAMLSeq<unknown>
                                                                                                                                                                                    : Node
                                                                                                                                                                              • Optionalname: string

                                                                                                                                                                              Returns Alias

                                                                                                                                                                            Settings

                                                                                                                                                                            Member Visibility
                                                                                                                                                                            diff --git a/docs/functions/_internal_.createConnection.html b/docs/functions/_internal_.createConnection.html deleted file mode 100644 index f8a74166..00000000 --- a/docs/functions/_internal_.createConnection.html +++ /dev/null @@ -1,13 +0,0 @@ -createConnection | ts-lambda-api - v2.5.2
                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                              Preparing search index...

                                                                                                                                                                              Function createConnection

                                                                                                                                                                              • Produces a socket/stream to be used for HTTP requests.

                                                                                                                                                                                -

                                                                                                                                                                                By default, this function is the same as net.createConnection(). However, -custom agents may override this method in case greater flexibility is desired.

                                                                                                                                                                                -

                                                                                                                                                                                A socket/stream can be supplied in one of two ways: by returning the -socket/stream from this function, or by passing the socket/stream to callback.

                                                                                                                                                                                -

                                                                                                                                                                                This method is guaranteed to return an instance of the net.Socket class, -a subclass of stream.Duplex, unless the user specifies a socket -type other than net.Socket.

                                                                                                                                                                                -

                                                                                                                                                                                callback has a signature of (err, stream).

                                                                                                                                                                                -

                                                                                                                                                                                Parameters

                                                                                                                                                                                • options: ClientRequestArgs

                                                                                                                                                                                  Options containing connection details. Check createConnection for the format of the options

                                                                                                                                                                                  -
                                                                                                                                                                                • Optionalcallback: (err: Error, stream: Duplex) => void

                                                                                                                                                                                  Callback function that receives the created socket

                                                                                                                                                                                  -

                                                                                                                                                                                Returns Duplex

                                                                                                                                                                                v0.11.4

                                                                                                                                                                                -

                                                                                                                                                                              Settings

                                                                                                                                                                              Member Visibility
                                                                                                                                                                              diff --git a/docs/functions/_internal_.createNode.html b/docs/functions/_internal_.createNode.html deleted file mode 100644 index b3077d37..00000000 --- a/docs/functions/_internal_.createNode.html +++ /dev/null @@ -1,5 +0,0 @@ -createNode | ts-lambda-api - v2.5.2
                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                Function createNode

                                                                                                                                                                                Settings

                                                                                                                                                                                Member Visibility
                                                                                                                                                                                diff --git a/docs/functions/_internal_.createPair.html b/docs/functions/_internal_.createPair.html deleted file mode 100644 index 16ffab55..00000000 --- a/docs/functions/_internal_.createPair.html +++ /dev/null @@ -1,3 +0,0 @@ -createPair | ts-lambda-api - v2.5.2
                                                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                  Function createPair

                                                                                                                                                                                  • Convert a key and a value into a Pair using the current schema, -recursively wrapping all values as Scalar or Collection nodes.

                                                                                                                                                                                    -

                                                                                                                                                                                    Type Parameters

                                                                                                                                                                                    Parameters

                                                                                                                                                                                    Returns Pair<K, V>

                                                                                                                                                                                  Settings

                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                  diff --git a/docs/functions/_internal_.delete-1.html b/docs/functions/_internal_.delete-1.html deleted file mode 100644 index fd1c07d1..00000000 --- a/docs/functions/_internal_.delete-1.html +++ /dev/null @@ -1,3 +0,0 @@ -delete | ts-lambda-api - v2.5.2
                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                    Function delete

                                                                                                                                                                                    • Removes a value from the collection.

                                                                                                                                                                                      -

                                                                                                                                                                                      Parameters

                                                                                                                                                                                      • key: unknown

                                                                                                                                                                                      Returns boolean

                                                                                                                                                                                      true if the item was found and removed.

                                                                                                                                                                                      -

                                                                                                                                                                                    Settings

                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                    diff --git a/docs/functions/_internal_.delete-2.html b/docs/functions/_internal_.delete-2.html deleted file mode 100644 index 305111af..00000000 --- a/docs/functions/_internal_.delete-2.html +++ /dev/null @@ -1,5 +0,0 @@ -delete | ts-lambda-api - v2.5.2
                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                      Function delete

                                                                                                                                                                                      • Removes a value from the collection.

                                                                                                                                                                                        -

                                                                                                                                                                                        key must contain a representation of an integer for this to succeed. -It may be wrapped in a Scalar.

                                                                                                                                                                                        -

                                                                                                                                                                                        Parameters

                                                                                                                                                                                        • key: unknown

                                                                                                                                                                                        Returns boolean

                                                                                                                                                                                        true if the item was found and removed.

                                                                                                                                                                                        -

                                                                                                                                                                                      Settings

                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                      diff --git a/docs/functions/_internal_.delete.html b/docs/functions/_internal_.delete.html deleted file mode 100644 index 69fc5d17..00000000 --- a/docs/functions/_internal_.delete.html +++ /dev/null @@ -1,3 +0,0 @@ -delete | ts-lambda-api - v2.5.2
                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                        Function delete

                                                                                                                                                                                        • Removes a value from the document.

                                                                                                                                                                                          -

                                                                                                                                                                                          Parameters

                                                                                                                                                                                          • key: unknown

                                                                                                                                                                                          Returns boolean

                                                                                                                                                                                          true if the item was found and removed.

                                                                                                                                                                                          -

                                                                                                                                                                                        Settings

                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                        diff --git a/docs/functions/_internal_.deleteIn.html b/docs/functions/_internal_.deleteIn.html deleted file mode 100644 index de1eca2c..00000000 --- a/docs/functions/_internal_.deleteIn.html +++ /dev/null @@ -1,3 +0,0 @@ -deleteIn | ts-lambda-api - v2.5.2
                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                          Function deleteIn

                                                                                                                                                                                          • Removes a value from the document.

                                                                                                                                                                                            -

                                                                                                                                                                                            Parameters

                                                                                                                                                                                            Returns boolean

                                                                                                                                                                                            true if the item was found and removed.

                                                                                                                                                                                            -

                                                                                                                                                                                          Settings

                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                          diff --git a/docs/functions/_internal_.destroy-1.html b/docs/functions/_internal_.destroy-1.html deleted file mode 100644 index 207e13ca..00000000 --- a/docs/functions/_internal_.destroy-1.html +++ /dev/null @@ -1,8 +0,0 @@ -destroy | ts-lambda-api - v2.5.2
                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                            Function destroy

                                                                                                                                                                                            • Destroy the stream. Optionally emit an 'error' event, and emit a 'close' event (unless emitClose is set to false). After this call, the readable -stream will release any internal resources and subsequent calls to push() will be ignored.

                                                                                                                                                                                              -

                                                                                                                                                                                              Once destroy() has been called any further calls will be a no-op and no -further errors except from _destroy() may be emitted as 'error'.

                                                                                                                                                                                              -

                                                                                                                                                                                              Implementors should not override this method, but instead implement readable._destroy().

                                                                                                                                                                                              -

                                                                                                                                                                                              Parameters

                                                                                                                                                                                              • Optionalerror: Error

                                                                                                                                                                                                Error which will be passed as payload in 'error' event

                                                                                                                                                                                                -

                                                                                                                                                                                              Returns this

                                                                                                                                                                                              v8.0.0

                                                                                                                                                                                              -

                                                                                                                                                                                            Settings

                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                            diff --git a/docs/functions/_internal_.destroy-2.html b/docs/functions/_internal_.destroy-2.html deleted file mode 100644 index c935f1cf..00000000 --- a/docs/functions/_internal_.destroy-2.html +++ /dev/null @@ -1,13 +0,0 @@ -destroy | ts-lambda-api - v2.5.2
                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                              Function destroy

                                                                                                                                                                                              • Destroy the stream. Optionally emit an 'error' event, and emit a 'close' event (unless emitClose is set to false). After this call, the writable -stream has ended and subsequent calls to write() or end() will result in -an ERR_STREAM_DESTROYED error. -This is a destructive and immediate way to destroy a stream. Previous calls to write() may not have drained, and may trigger an ERR_STREAM_DESTROYED error. -Use end() instead of destroy if data should flush before close, or wait for -the 'drain' event before destroying the stream.

                                                                                                                                                                                                -

                                                                                                                                                                                                Once destroy() has been called any further calls will be a no-op and no -further errors except from _destroy() may be emitted as 'error'.

                                                                                                                                                                                                -

                                                                                                                                                                                                Implementors should not override this method, -but instead implement writable._destroy().

                                                                                                                                                                                                -

                                                                                                                                                                                                Parameters

                                                                                                                                                                                                • Optionalerror: Error

                                                                                                                                                                                                  Optional, an error to emit with 'error' event.

                                                                                                                                                                                                  -

                                                                                                                                                                                                Returns this

                                                                                                                                                                                                v8.0.0

                                                                                                                                                                                                -

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                              diff --git a/docs/functions/_internal_.destroy.html b/docs/functions/_internal_.destroy.html deleted file mode 100644 index d567f8d1..00000000 --- a/docs/functions/_internal_.destroy.html +++ /dev/null @@ -1 +0,0 @@ -destroy | ts-lambda-api - v2.5.2
                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                Function destroyOptional

                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                  • this: T
                                                                                                                                                                                                  • error: Error
                                                                                                                                                                                                  • callback: (error?: Error) => void

                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                Settings

                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                diff --git a/docs/functions/_internal_.emit-1.html b/docs/functions/_internal_.emit-1.html deleted file mode 100644 index 0d7ce1ef..00000000 --- a/docs/functions/_internal_.emit-1.html +++ /dev/null @@ -1,8 +0,0 @@ -emit | ts-lambda-api - v2.5.2
                                                                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                  Function emit

                                                                                                                                                                                                  • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments -to each.

                                                                                                                                                                                                    -

                                                                                                                                                                                                    Returns true if the event had listeners, false otherwise.

                                                                                                                                                                                                    -
                                                                                                                                                                                                    import { EventEmitter } from 'node:events';
                                                                                                                                                                                                    const myEmitter = new EventEmitter();

                                                                                                                                                                                                    // First listener
                                                                                                                                                                                                    myEmitter.on('event', function firstListener() {
                                                                                                                                                                                                      console.log('Helloooo! first listener');
                                                                                                                                                                                                    });
                                                                                                                                                                                                    // Second listener
                                                                                                                                                                                                    myEmitter.on('event', function secondListener(arg1, arg2) {
                                                                                                                                                                                                      console.log(`event with parameters ${arg1}, ${arg2} in second listener`);
                                                                                                                                                                                                    });
                                                                                                                                                                                                    // Third listener
                                                                                                                                                                                                    myEmitter.on('event', function thirdListener(...args) {
                                                                                                                                                                                                      const parameters = args.join(', ');
                                                                                                                                                                                                      console.log(`event with parameters ${parameters} in third listener`);
                                                                                                                                                                                                    });

                                                                                                                                                                                                    console.log(myEmitter.listeners('event'));

                                                                                                                                                                                                    myEmitter.emit('event', 1, 2, 3, 4, 5);

                                                                                                                                                                                                    // Prints:
                                                                                                                                                                                                    // [
                                                                                                                                                                                                    //   [Function: firstListener],
                                                                                                                                                                                                    //   [Function: secondListener],
                                                                                                                                                                                                    //   [Function: thirdListener]
                                                                                                                                                                                                    // ]
                                                                                                                                                                                                    // Helloooo! first listener
                                                                                                                                                                                                    // event with parameters 1, 2 in second listener
                                                                                                                                                                                                    // event with parameters 1, 2, 3, 4, 5 in third listener
-
                                                                                                                                                                                                    - -

                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                    • event: "close"

                                                                                                                                                                                                    Returns boolean

                                                                                                                                                                                                    v0.1.26

                                                                                                                                                                                                    -

                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                    • event: "data"
                                                                                                                                                                                                    • chunk: any

                                                                                                                                                                                                    Returns boolean

                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                    • event: "drain"

                                                                                                                                                                                                    Returns boolean

                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                    • event: "end"

                                                                                                                                                                                                    Returns boolean

                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                    • event: "error"
                                                                                                                                                                                                    • err: Error

                                                                                                                                                                                                    Returns boolean

                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                    • event: "finish"

                                                                                                                                                                                                    Returns boolean

                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                    • event: "pause"

                                                                                                                                                                                                    Returns boolean

                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                    Returns boolean

                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                    • event: "readable"

                                                                                                                                                                                                    Returns boolean

                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                    • event: "resume"

                                                                                                                                                                                                    Returns boolean

                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                    Returns boolean

                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                    • event: string | symbol
                                                                                                                                                                                                    • ...args: any[]

                                                                                                                                                                                                    Returns boolean

                                                                                                                                                                                                  Settings

                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                  diff --git a/docs/functions/_internal_.emit-2.html b/docs/functions/_internal_.emit-2.html deleted file mode 100644 index 43ea5942..00000000 --- a/docs/functions/_internal_.emit-2.html +++ /dev/null @@ -1,8 +0,0 @@ -emit | ts-lambda-api - v2.5.2
                                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                    Function emit

                                                                                                                                                                                                    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments -to each.

                                                                                                                                                                                                      -

                                                                                                                                                                                                      Returns true if the event had listeners, false otherwise.

                                                                                                                                                                                                      -
                                                                                                                                                                                                      import { EventEmitter } from 'node:events';
                                                                                                                                                                                                      const myEmitter = new EventEmitter();

                                                                                                                                                                                                      // First listener
                                                                                                                                                                                                      myEmitter.on('event', function firstListener() {
                                                                                                                                                                                                        console.log('Helloooo! first listener');
                                                                                                                                                                                                      });
                                                                                                                                                                                                      // Second listener
                                                                                                                                                                                                      myEmitter.on('event', function secondListener(arg1, arg2) {
                                                                                                                                                                                                        console.log(`event with parameters ${arg1}, ${arg2} in second listener`);
                                                                                                                                                                                                      });
                                                                                                                                                                                                      // Third listener
                                                                                                                                                                                                      myEmitter.on('event', function thirdListener(...args) {
                                                                                                                                                                                                        const parameters = args.join(', ');
                                                                                                                                                                                                        console.log(`event with parameters ${parameters} in third listener`);
                                                                                                                                                                                                      });

                                                                                                                                                                                                      console.log(myEmitter.listeners('event'));

                                                                                                                                                                                                      myEmitter.emit('event', 1, 2, 3, 4, 5);

                                                                                                                                                                                                      // Prints:
                                                                                                                                                                                                      // [
                                                                                                                                                                                                      //   [Function: firstListener],
                                                                                                                                                                                                      //   [Function: secondListener],
                                                                                                                                                                                                      //   [Function: thirdListener]
                                                                                                                                                                                                      // ]
                                                                                                                                                                                                      // Helloooo! first listener
                                                                                                                                                                                                      // event with parameters 1, 2 in second listener
                                                                                                                                                                                                      // event with parameters 1, 2, 3, 4, 5 in third listener
-
                                                                                                                                                                                                      - -

                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                      • event: "close"

                                                                                                                                                                                                      Returns boolean

                                                                                                                                                                                                      v0.1.26

                                                                                                                                                                                                      -

                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                      • event: "data"
                                                                                                                                                                                                      • chunk: any

                                                                                                                                                                                                      Returns boolean

                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                      • event: "end"

                                                                                                                                                                                                      Returns boolean

                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                      • event: "error"
                                                                                                                                                                                                      • err: Error

                                                                                                                                                                                                      Returns boolean

                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                      • event: "pause"

                                                                                                                                                                                                      Returns boolean

                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                      • event: "readable"

                                                                                                                                                                                                      Returns boolean

                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                      • event: "resume"

                                                                                                                                                                                                      Returns boolean

                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                      • event: string | symbol
                                                                                                                                                                                                      • ...args: any[]

                                                                                                                                                                                                      Returns boolean

                                                                                                                                                                                                    Settings

                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                    diff --git a/docs/functions/_internal_.emit-3.html b/docs/functions/_internal_.emit-3.html deleted file mode 100644 index 47f0445a..00000000 --- a/docs/functions/_internal_.emit-3.html +++ /dev/null @@ -1,8 +0,0 @@ -emit | ts-lambda-api - v2.5.2
                                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                      Function emit

                                                                                                                                                                                                      • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments -to each.

                                                                                                                                                                                                        -

                                                                                                                                                                                                        Returns true if the event had listeners, false otherwise.

                                                                                                                                                                                                        -
                                                                                                                                                                                                        import { EventEmitter } from 'node:events';
                                                                                                                                                                                                        const myEmitter = new EventEmitter();

                                                                                                                                                                                                        // First listener
                                                                                                                                                                                                        myEmitter.on('event', function firstListener() {
                                                                                                                                                                                                          console.log('Helloooo! first listener');
                                                                                                                                                                                                        });
                                                                                                                                                                                                        // Second listener
                                                                                                                                                                                                        myEmitter.on('event', function secondListener(arg1, arg2) {
                                                                                                                                                                                                          console.log(`event with parameters ${arg1}, ${arg2} in second listener`);
                                                                                                                                                                                                        });
                                                                                                                                                                                                        // Third listener
                                                                                                                                                                                                        myEmitter.on('event', function thirdListener(...args) {
                                                                                                                                                                                                          const parameters = args.join(', ');
                                                                                                                                                                                                          console.log(`event with parameters ${parameters} in third listener`);
                                                                                                                                                                                                        });

                                                                                                                                                                                                        console.log(myEmitter.listeners('event'));

                                                                                                                                                                                                        myEmitter.emit('event', 1, 2, 3, 4, 5);

                                                                                                                                                                                                        // Prints:
                                                                                                                                                                                                        // [
                                                                                                                                                                                                        //   [Function: firstListener],
                                                                                                                                                                                                        //   [Function: secondListener],
                                                                                                                                                                                                        //   [Function: thirdListener]
                                                                                                                                                                                                        // ]
                                                                                                                                                                                                        // Helloooo! first listener
                                                                                                                                                                                                        // event with parameters 1, 2 in second listener
                                                                                                                                                                                                        // event with parameters 1, 2, 3, 4, 5 in third listener
-
                                                                                                                                                                                                        - -

                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                        • event: "close"

                                                                                                                                                                                                        Returns boolean

                                                                                                                                                                                                        v0.1.26

                                                                                                                                                                                                        -

                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                        • event: "drain"

                                                                                                                                                                                                        Returns boolean

                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                        • event: "error"
                                                                                                                                                                                                        • err: Error

                                                                                                                                                                                                        Returns boolean

                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                        • event: "finish"

                                                                                                                                                                                                        Returns boolean

                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                        Returns boolean

                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                        Returns boolean

                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                        • event: string | symbol
                                                                                                                                                                                                        • ...args: any[]

                                                                                                                                                                                                        Returns boolean

                                                                                                                                                                                                      Settings

                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                      diff --git a/docs/functions/_internal_.emit.html b/docs/functions/_internal_.emit.html deleted file mode 100644 index 6baf3816..00000000 --- a/docs/functions/_internal_.emit.html +++ /dev/null @@ -1,8 +0,0 @@ -emit | ts-lambda-api - v2.5.2
                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                        Function emit

                                                                                                                                                                                                        • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments -to each.

                                                                                                                                                                                                          -

                                                                                                                                                                                                          Returns true if the event had listeners, false otherwise.

                                                                                                                                                                                                          -
                                                                                                                                                                                                          import { EventEmitter } from 'node:events';
                                                                                                                                                                                                          const myEmitter = new EventEmitter();

                                                                                                                                                                                                          // First listener
                                                                                                                                                                                                          myEmitter.on('event', function firstListener() {
                                                                                                                                                                                                            console.log('Helloooo! first listener');
                                                                                                                                                                                                          });
                                                                                                                                                                                                          // Second listener
                                                                                                                                                                                                          myEmitter.on('event', function secondListener(arg1, arg2) {
                                                                                                                                                                                                            console.log(`event with parameters ${arg1}, ${arg2} in second listener`);
                                                                                                                                                                                                          });
                                                                                                                                                                                                          // Third listener
                                                                                                                                                                                                          myEmitter.on('event', function thirdListener(...args) {
                                                                                                                                                                                                            const parameters = args.join(', ');
                                                                                                                                                                                                            console.log(`event with parameters ${parameters} in third listener`);
                                                                                                                                                                                                          });

                                                                                                                                                                                                          console.log(myEmitter.listeners('event'));

                                                                                                                                                                                                          myEmitter.emit('event', 1, 2, 3, 4, 5);

                                                                                                                                                                                                          // Prints:
                                                                                                                                                                                                          // [
                                                                                                                                                                                                          //   [Function: firstListener],
                                                                                                                                                                                                          //   [Function: secondListener],
                                                                                                                                                                                                          //   [Function: thirdListener]
                                                                                                                                                                                                          // ]
                                                                                                                                                                                                          // Helloooo! first listener
                                                                                                                                                                                                          // event with parameters 1, 2 in second listener
                                                                                                                                                                                                          // event with parameters 1, 2, 3, 4, 5 in third listener
-
                                                                                                                                                                                                          - -

                                                                                                                                                                                                          Type Parameters

                                                                                                                                                                                                          • K

                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                          Returns boolean

                                                                                                                                                                                                          v0.1.26

                                                                                                                                                                                                          -

                                                                                                                                                                                                        Settings

                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                        diff --git a/docs/functions/_internal_.emitDestroy.html b/docs/functions/_internal_.emitDestroy.html deleted file mode 100644 index ac7a9ba8..00000000 --- a/docs/functions/_internal_.emitDestroy.html +++ /dev/null @@ -1,6 +0,0 @@ -emitDestroy | ts-lambda-api - v2.5.2
                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                          Function emitDestroy

                                                                                                                                                                                                          • Call all destroy hooks. This should only ever be called once. An error will -be thrown if it is called more than once. This must be manually called. If -the resource is left to be collected by the GC then the destroy hooks will -never be called.

                                                                                                                                                                                                            -

                                                                                                                                                                                                            Returns this

                                                                                                                                                                                                            A reference to asyncResource.

                                                                                                                                                                                                            -

                                                                                                                                                                                                          Settings

                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                          diff --git a/docs/functions/_internal_.end-1.html b/docs/functions/_internal_.end-1.html deleted file mode 100644 index 85b986e8..00000000 --- a/docs/functions/_internal_.end-1.html +++ /dev/null @@ -1,33 +0,0 @@ -end | ts-lambda-api - v2.5.2
                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                            Function end

                                                                                                                                                                                                            • Calling the writable.end() method signals that no more data will be written -to the Writable. The optional chunk and encoding arguments allow one -final additional chunk of data to be written immediately before closing the -stream.

                                                                                                                                                                                                              -

                                                                                                                                                                                                              Calling the write method after calling end will raise an error.

                                                                                                                                                                                                              -
                                                                                                                                                                                                              // Write 'hello, ' and then end with 'world!'.
                                                                                                                                                                                                              import fs from 'node:fs';
                                                                                                                                                                                                              const file = fs.createWriteStream('example.txt');
                                                                                                                                                                                                              file.write('hello, ');
                                                                                                                                                                                                              file.end('world!');
                                                                                                                                                                                                              // Writing more now is not allowed!
-
                                                                                                                                                                                                              - -

                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                              • Optionalcb: () => void

                                                                                                                                                                                                              Returns this

                                                                                                                                                                                                              v0.9.4

                                                                                                                                                                                                              -

                                                                                                                                                                                                            • Calling the writable.end() method signals that no more data will be written -to the Writable. The optional chunk and encoding arguments allow one -final additional chunk of data to be written immediately before closing the -stream.

                                                                                                                                                                                                              -

                                                                                                                                                                                                              Calling the write method after calling end will raise an error.

                                                                                                                                                                                                              -
                                                                                                                                                                                                              // Write 'hello, ' and then end with 'world!'.
                                                                                                                                                                                                              import fs from 'node:fs';
                                                                                                                                                                                                              const file = fs.createWriteStream('example.txt');
                                                                                                                                                                                                              file.write('hello, ');
                                                                                                                                                                                                              file.end('world!');
                                                                                                                                                                                                              // Writing more now is not allowed!
-
                                                                                                                                                                                                              - -

                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                              • chunk: any

                                                                                                                                                                                                                Optional data to write. For streams not operating in object mode, chunk must be a {string}, {Buffer}, -{TypedArray} or {DataView}. For object mode streams, chunk may be any JavaScript value other than null.

                                                                                                                                                                                                                -
                                                                                                                                                                                                              • Optionalcb: () => void

                                                                                                                                                                                                              Returns this

                                                                                                                                                                                                              v0.9.4

                                                                                                                                                                                                              -

                                                                                                                                                                                                            • Calling the writable.end() method signals that no more data will be written -to the Writable. The optional chunk and encoding arguments allow one -final additional chunk of data to be written immediately before closing the -stream.

                                                                                                                                                                                                              -

                                                                                                                                                                                                              Calling the write method after calling end will raise an error.

                                                                                                                                                                                                              -
                                                                                                                                                                                                              // Write 'hello, ' and then end with 'world!'.
                                                                                                                                                                                                              import fs from 'node:fs';
                                                                                                                                                                                                              const file = fs.createWriteStream('example.txt');
                                                                                                                                                                                                              file.write('hello, ');
                                                                                                                                                                                                              file.end('world!');
                                                                                                                                                                                                              // Writing more now is not allowed!
-
                                                                                                                                                                                                              - -

                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                              • chunk: any

                                                                                                                                                                                                                Optional data to write. For streams not operating in object mode, chunk must be a {string}, {Buffer}, -{TypedArray} or {DataView}. For object mode streams, chunk may be any JavaScript value other than null.

                                                                                                                                                                                                                -
                                                                                                                                                                                                              • encoding: BufferEncoding

                                                                                                                                                                                                                The encoding if chunk is a string

                                                                                                                                                                                                                -
                                                                                                                                                                                                              • Optionalcb: () => void

                                                                                                                                                                                                              Returns this

                                                                                                                                                                                                              v0.9.4

                                                                                                                                                                                                              -

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                            diff --git a/docs/functions/_internal_.end.html b/docs/functions/_internal_.end.html deleted file mode 100644 index 71adfa42..00000000 --- a/docs/functions/_internal_.end.html +++ /dev/null @@ -1 +0,0 @@ -end | ts-lambda-api - v2.5.2
                                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                              Function end

                                                                                                                                                                                                              • Parameters

                                                                                                                                                                                                                • Optionalcb: () => void

                                                                                                                                                                                                                Returns this

                                                                                                                                                                                                              • Parameters

                                                                                                                                                                                                                Returns this

                                                                                                                                                                                                              • Parameters

                                                                                                                                                                                                                Returns this

                                                                                                                                                                                                              Settings

                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                              diff --git a/docs/functions/_internal_.eventNames.html b/docs/functions/_internal_.eventNames.html deleted file mode 100644 index dfde4de0..00000000 --- a/docs/functions/_internal_.eventNames.html +++ /dev/null @@ -1,7 +0,0 @@ -eventNames | ts-lambda-api - v2.5.2
                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                Function eventNames

                                                                                                                                                                                                                • Returns an array listing the events for which the emitter has registered -listeners. The values in the array are strings or Symbols.

                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  import { EventEmitter } from 'node:events';

                                                                                                                                                                                                                  const myEE = new EventEmitter();
                                                                                                                                                                                                                  myEE.on('foo', () => {});
                                                                                                                                                                                                                  myEE.on('bar', () => {});

                                                                                                                                                                                                                  const sym = Symbol('symbol');
                                                                                                                                                                                                                  myEE.on(sym, () => {});

                                                                                                                                                                                                                  console.log(myEE.eventNames());
                                                                                                                                                                                                                  // Prints: [ 'foo', 'bar', Symbol(symbol) ]
-
                                                                                                                                                                                                                  - -

                                                                                                                                                                                                                  Returns ((string | symbol) & Key2<unknown, T>)[]

                                                                                                                                                                                                                  v6.0.0

                                                                                                                                                                                                                  -

                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                diff --git a/docs/functions/_internal_.every.html b/docs/functions/_internal_.every.html deleted file mode 100644 index 0608350f..00000000 --- a/docs/functions/_internal_.every.html +++ /dev/null @@ -1,8 +0,0 @@ -every | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                  Function every

                                                                                                                                                                                                                  • This method is similar to Array.prototype.every and calls fn on each chunk in the stream -to check if all awaited return values are truthy value for fn. Once an fn call on a chunk -awaited return value is falsy, the stream is destroyed and the promise is fulfilled with false. -If all of the fn calls on the chunks return a truthy value, the promise is fulfilled with true.

                                                                                                                                                                                                                    -

                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                    • fn: (
                                                                                                                                                                                                                          data: any,
                                                                                                                                                                                                                          options?: Pick<Stream.ArrayOptions, "signal">,
                                                                                                                                                                                                                      ) => boolean | Promise<boolean>

                                                                                                                                                                                                                      a function to call on each chunk of the stream. Async or not.

                                                                                                                                                                                                                      -
                                                                                                                                                                                                                    • Optionaloptions: Stream.ArrayOptions

                                                                                                                                                                                                                    Returns Promise<boolean>

                                                                                                                                                                                                                    a promise evaluating to true if fn returned a truthy value for every one of the chunks.

                                                                                                                                                                                                                    -

                                                                                                                                                                                                                    v17.5.0

                                                                                                                                                                                                                    -

                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                  diff --git a/docs/functions/_internal_.extractAuthData.html b/docs/functions/_internal_.extractAuthData.html deleted file mode 100644 index 994c2c53..00000000 --- a/docs/functions/_internal_.extractAuthData.html +++ /dev/null @@ -1,6 +0,0 @@ -extractAuthData | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                    Function extractAuthData

                                                                                                                                                                                                                    • Extract an instance of the authentication data type T -from a HTTP request. If extraction is not possible due to -missing request headers/data, undefined should be returned.

                                                                                                                                                                                                                      -

                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                      • request: Request

                                                                                                                                                                                                                        Request context to use.

                                                                                                                                                                                                                        -

                                                                                                                                                                                                                      Returns Promise<T>

                                                                                                                                                                                                                      Instance of type T or undefined on extraction failure.

                                                                                                                                                                                                                      -

                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                    diff --git a/docs/functions/_internal_.filter.html b/docs/functions/_internal_.filter.html deleted file mode 100644 index b8ec0a4f..00000000 --- a/docs/functions/_internal_.filter.html +++ /dev/null @@ -1,7 +0,0 @@ -filter | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                      Function filter

                                                                                                                                                                                                                      • This method allows filtering the stream. For each chunk in the stream the fn function will be called -and if it returns a truthy value, the chunk will be passed to the result stream. -If the fn function returns a promise - that promise will be awaited.

                                                                                                                                                                                                                        -

                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                        • fn: (
                                                                                                                                                                                                                              data: any,
                                                                                                                                                                                                                              options?: Pick<Stream.ArrayOptions, "signal">,
                                                                                                                                                                                                                          ) => boolean | Promise<boolean>

                                                                                                                                                                                                                          a function to filter chunks from the stream. Async or not.

                                                                                                                                                                                                                          -
                                                                                                                                                                                                                        • Optionaloptions: Stream.ArrayOptions

                                                                                                                                                                                                                        Returns Readable

                                                                                                                                                                                                                        a stream filtered with the predicate fn.

                                                                                                                                                                                                                        -

                                                                                                                                                                                                                        v17.4.0, v16.14.0

                                                                                                                                                                                                                        -

                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                      diff --git a/docs/functions/_internal_.final.html b/docs/functions/_internal_.final.html deleted file mode 100644 index 7a49144f..00000000 --- a/docs/functions/_internal_.final.html +++ /dev/null @@ -1 +0,0 @@ -final | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                        Function finalOptional

                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                          • this: T
                                                                                                                                                                                                                          • callback: (error?: Error) => void

                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                        diff --git a/docs/functions/_internal_.find.html b/docs/functions/_internal_.find.html deleted file mode 100644 index a45a93b7..00000000 --- a/docs/functions/_internal_.find.html +++ /dev/null @@ -1,17 +0,0 @@ -find | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                          Function find

                                                                                                                                                                                                                          • This method is similar to Array.prototype.find and calls fn on each chunk in the stream -to find a chunk with a truthy value for fn. Once an fn call's awaited return value is truthy, -the stream is destroyed and the promise is fulfilled with value for which fn returned a truthy value. -If all of the fn calls on the chunks return a falsy value, the promise is fulfilled with undefined.

                                                                                                                                                                                                                            -

                                                                                                                                                                                                                            Type Parameters

                                                                                                                                                                                                                            • T

                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                            Returns Promise<T>

                                                                                                                                                                                                                            a promise evaluating to the first chunk for which fn evaluated with a truthy value, -or undefined if no element was found.

                                                                                                                                                                                                                            -

                                                                                                                                                                                                                            v17.5.0

                                                                                                                                                                                                                            -

                                                                                                                                                                                                                          • This method is similar to Array.prototype.find and calls fn on each chunk in the stream -to find a chunk with a truthy value for fn. Once an fn call's awaited return value is truthy, -the stream is destroyed and the promise is fulfilled with value for which fn returned a truthy value. -If all of the fn calls on the chunks return a falsy value, the promise is fulfilled with undefined.

                                                                                                                                                                                                                            -

                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                            • fn: (
                                                                                                                                                                                                                                  data: any,
                                                                                                                                                                                                                                  options?: Pick<Stream.ArrayOptions, "signal">,
                                                                                                                                                                                                                              ) => boolean | Promise<boolean>

                                                                                                                                                                                                                              a function to call on each chunk of the stream. Async or not.

                                                                                                                                                                                                                              -
                                                                                                                                                                                                                            • Optionaloptions: Stream.ArrayOptions

                                                                                                                                                                                                                            Returns Promise<any>

                                                                                                                                                                                                                            a promise evaluating to the first chunk for which fn evaluated with a truthy value, -or undefined if no element was found.

                                                                                                                                                                                                                            -

                                                                                                                                                                                                                            v17.5.0

                                                                                                                                                                                                                            -

                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                          diff --git a/docs/functions/_internal_.flatMap.html b/docs/functions/_internal_.flatMap.html deleted file mode 100644 index 169b77b2..00000000 --- a/docs/functions/_internal_.flatMap.html +++ /dev/null @@ -1,8 +0,0 @@ -flatMap | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                            Function flatMap

                                                                                                                                                                                                                            • This method returns a new stream by applying the given callback to each chunk of the stream -and then flattening the result.

                                                                                                                                                                                                                              -

                                                                                                                                                                                                                              It is possible to return a stream or another iterable or async iterable from fn and the result streams -will be merged (flattened) into the returned stream.

                                                                                                                                                                                                                              -

                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                              • fn: (data: any, options?: Pick<Stream.ArrayOptions, "signal">) => any

                                                                                                                                                                                                                                a function to map over every chunk in the stream. May be async. May be a stream or generator.

                                                                                                                                                                                                                                -
                                                                                                                                                                                                                              • Optionaloptions: Stream.ArrayOptions

                                                                                                                                                                                                                              Returns Readable

                                                                                                                                                                                                                              a stream flat-mapped with the function fn.

                                                                                                                                                                                                                              -

                                                                                                                                                                                                                              v17.5.0

                                                                                                                                                                                                                              -

                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                            diff --git a/docs/functions/_internal_.flushHeaders.html b/docs/functions/_internal_.flushHeaders.html deleted file mode 100644 index 08024f4d..00000000 --- a/docs/functions/_internal_.flushHeaders.html +++ /dev/null @@ -1,9 +0,0 @@ -flushHeaders | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                              Function flushHeaders

                                                                                                                                                                                                                              • Flushes the message headers.

                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                For efficiency reason, Node.js normally buffers the message headers -until outgoingMessage.end() is called or the first chunk of message data -is written. It then tries to pack the headers and data into a single TCP -packet.

                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                It is usually desired (it saves a TCP round-trip), but not when the first -data is not sent until possibly much later. outgoingMessage.flushHeaders() bypasses the optimization and kickstarts the message.

                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                Returns void

                                                                                                                                                                                                                                v1.6.0

                                                                                                                                                                                                                                -

                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                              diff --git a/docs/functions/_internal_.forEach.html b/docs/functions/_internal_.forEach.html deleted file mode 100644 index 1a5c3203..00000000 --- a/docs/functions/_internal_.forEach.html +++ /dev/null @@ -1,12 +0,0 @@ -forEach | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                Function forEach

                                                                                                                                                                                                                                • This method allows iterating a stream. For each chunk in the stream the fn function will be called. -If the fn function returns a promise - that promise will be awaited.

                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                  This method is different from for await...of loops in that it can optionally process chunks concurrently. -In addition, a forEach iteration can only be stopped by having passed a signal option -and aborting the related AbortController while for await...of can be stopped with break or return. -In either case the stream will be destroyed.

                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                  This method is different from listening to the 'data' event in that it uses the readable event -in the underlying machinary and can limit the number of concurrent fn calls.

                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                  • fn: (
                                                                                                                                                                                                                                        data: any,
                                                                                                                                                                                                                                        options?: Pick<Stream.ArrayOptions, "signal">,
                                                                                                                                                                                                                                    ) => void | Promise<void>

                                                                                                                                                                                                                                    a function to call on each chunk of the stream. Async or not.

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                  • Optionaloptions: Stream.ArrayOptions

                                                                                                                                                                                                                                  Returns Promise<void>

                                                                                                                                                                                                                                  a promise for when the stream has finished.

                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                  v17.5.0

                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                diff --git a/docs/functions/_internal_.get-1.html b/docs/functions/_internal_.get-1.html deleted file mode 100644 index 886f7541..00000000 --- a/docs/functions/_internal_.get-1.html +++ /dev/null @@ -1,4 +0,0 @@ -get | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                  Function get

                                                                                                                                                                                                                                  • Returns item at key, or undefined if not found. By default unwraps -scalar values from their surrounding node; to disable set keepScalar to -true (collections are always returned intact).

                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                    • key: unknown
                                                                                                                                                                                                                                    • keepScalar: true

                                                                                                                                                                                                                                    Returns Scalar<V>

                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                    • key: unknown
                                                                                                                                                                                                                                    • OptionalkeepScalar: false

                                                                                                                                                                                                                                    Returns V

                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                    • key: unknown
                                                                                                                                                                                                                                    • OptionalkeepScalar: boolean

                                                                                                                                                                                                                                    Returns V | Scalar<V>

                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                  diff --git a/docs/functions/_internal_.get-2.html b/docs/functions/_internal_.get-2.html deleted file mode 100644 index 3d0d8218..00000000 --- a/docs/functions/_internal_.get-2.html +++ /dev/null @@ -1,16 +0,0 @@ -get | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                    Function get

                                                                                                                                                                                                                                    • Returns item at key, or undefined if not found. By default unwraps -scalar values from their surrounding node; to disable set keepScalar to -true (collections are always returned intact).

                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                      key must contain a representation of an integer for this to succeed. -It may be wrapped in a Scalar.

                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                      • key: unknown
                                                                                                                                                                                                                                      • keepScalar: true

                                                                                                                                                                                                                                      Returns Scalar<T>

                                                                                                                                                                                                                                    • Returns item at key, or undefined if not found. By default unwraps -scalar values from their surrounding node; to disable set keepScalar to -true (collections are always returned intact).

                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                      key must contain a representation of an integer for this to succeed. -It may be wrapped in a Scalar.

                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                      • key: unknown
                                                                                                                                                                                                                                      • OptionalkeepScalar: false

                                                                                                                                                                                                                                      Returns T

                                                                                                                                                                                                                                    • Returns item at key, or undefined if not found. By default unwraps -scalar values from their surrounding node; to disable set keepScalar to -true (collections are always returned intact).

                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                      key must contain a representation of an integer for this to succeed. -It may be wrapped in a Scalar.

                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                      • key: unknown
                                                                                                                                                                                                                                      • OptionalkeepScalar: boolean

                                                                                                                                                                                                                                      Returns T | Scalar<T>

                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                    diff --git a/docs/functions/_internal_.get.html b/docs/functions/_internal_.get.html deleted file mode 100644 index be11702b..00000000 --- a/docs/functions/_internal_.get.html +++ /dev/null @@ -1,4 +0,0 @@ -get | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                      Function get

                                                                                                                                                                                                                                      • Returns item at key, or undefined if not found. By default unwraps -scalar values from their surrounding node; to disable set keepScalar to -true (collections are always returned intact).

                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                        • key: unknown
                                                                                                                                                                                                                                        • OptionalkeepScalar: boolean

                                                                                                                                                                                                                                        Returns Strict extends true ? unknown : any

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                      diff --git a/docs/functions/_internal_.getHeader.html b/docs/functions/_internal_.getHeader.html deleted file mode 100644 index ca5d7f91..00000000 --- a/docs/functions/_internal_.getHeader.html +++ /dev/null @@ -1,5 +0,0 @@ -getHeader | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                        Function getHeader

                                                                                                                                                                                                                                        • Gets the value of the HTTP header with the given name. If that header is not -set, the returned value will be undefined.

                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                          • name: string

                                                                                                                                                                                                                                            Name of header

                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                          Returns string | number | string[]

                                                                                                                                                                                                                                          v0.4.0

                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                        diff --git a/docs/functions/_internal_.getHeaderNames.html b/docs/functions/_internal_.getHeaderNames.html deleted file mode 100644 index 60b34542..00000000 --- a/docs/functions/_internal_.getHeaderNames.html +++ /dev/null @@ -1,4 +0,0 @@ -getHeaderNames | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                          Function getHeaderNames

                                                                                                                                                                                                                                          • Returns an array containing the unique names of the current outgoing headers. -All names are lowercase.

                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                            Returns string[]

                                                                                                                                                                                                                                            v7.7.0

                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                          diff --git a/docs/functions/_internal_.getHeaders.html b/docs/functions/_internal_.getHeaders.html deleted file mode 100644 index c0ba1f23..00000000 --- a/docs/functions/_internal_.getHeaders.html +++ /dev/null @@ -1,14 +0,0 @@ -getHeaders | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                            Function getHeaders

                                                                                                                                                                                                                                            • Returns a shallow copy of the current outgoing headers. Since a shallow -copy is used, array values may be mutated without additional calls to -various header-related HTTP module methods. The keys of the returned -object are the header names and the values are the respective header -values. All header names are lowercase.

                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                              The object returned by the outgoingMessage.getHeaders() method does -not prototypically inherit from the JavaScript Object. This means that -typical Object methods such as obj.toString(), obj.hasOwnProperty(), -and others are not defined and will not work.

                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                              outgoingMessage.setHeader('Foo', 'bar');
                                                                                                                                                                                                                                              outgoingMessage.setHeader('Set-Cookie', ['foo=bar', 'bar=baz']);

                                                                                                                                                                                                                                              const headers = outgoingMessage.getHeaders();
                                                                                                                                                                                                                                              // headers === { foo: 'bar', 'set-cookie': ['foo=bar', 'bar=baz'] }
-
                                                                                                                                                                                                                                              - -

                                                                                                                                                                                                                                              Returns OutgoingHttpHeaders

                                                                                                                                                                                                                                              v7.7.0

                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                            diff --git a/docs/functions/_internal_.getIn.html b/docs/functions/_internal_.getIn.html deleted file mode 100644 index bfb6b57e..00000000 --- a/docs/functions/_internal_.getIn.html +++ /dev/null @@ -1,4 +0,0 @@ -getIn | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                              Function getIn

                                                                                                                                                                                                                                              • Returns item at path, or undefined if not found. By default unwraps -scalar values from their surrounding node; to disable set keepScalar to -true (collections are always returned intact).

                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                • path: Iterable<unknown, any, any>
                                                                                                                                                                                                                                                • OptionalkeepScalar: boolean

                                                                                                                                                                                                                                                Returns Strict extends true ? unknown : any

                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                              diff --git a/docs/functions/_internal_.getMaxListeners.html b/docs/functions/_internal_.getMaxListeners.html deleted file mode 100644 index e8a4bb9e..00000000 --- a/docs/functions/_internal_.getMaxListeners.html +++ /dev/null @@ -1,4 +0,0 @@ -getMaxListeners | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                Function getMaxListeners

                                                                                                                                                                                                                                                • Returns the current max listener value for the EventEmitter which is either -set by emitter.setMaxListeners(n) or defaults to EventEmitter.defaultMaxListeners.

                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                  Returns number

                                                                                                                                                                                                                                                  v1.0.0

                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                diff --git a/docs/functions/_internal_.has-1.html b/docs/functions/_internal_.has-1.html deleted file mode 100644 index f722bd48..00000000 --- a/docs/functions/_internal_.has-1.html +++ /dev/null @@ -1,2 +0,0 @@ -has | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                  Function has

                                                                                                                                                                                                                                                  • Checks if the collection includes a value with the key key.

                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                    • key: unknown

                                                                                                                                                                                                                                                    Returns boolean

                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                  diff --git a/docs/functions/_internal_.has-2.html b/docs/functions/_internal_.has-2.html deleted file mode 100644 index 64db5c5b..00000000 --- a/docs/functions/_internal_.has-2.html +++ /dev/null @@ -1,4 +0,0 @@ -has | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                    Function has

                                                                                                                                                                                                                                                    • Checks if the collection includes a value with the key key.

                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                      key must contain a representation of an integer for this to succeed. -It may be wrapped in a Scalar.

                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                      • key: unknown

                                                                                                                                                                                                                                                      Returns boolean

                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                    diff --git a/docs/functions/_internal_.has.html b/docs/functions/_internal_.has.html deleted file mode 100644 index a91194b6..00000000 --- a/docs/functions/_internal_.has.html +++ /dev/null @@ -1,2 +0,0 @@ -has | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                      Function has

                                                                                                                                                                                                                                                      • Checks if the document includes a value with the key key.

                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                        • key: unknown

                                                                                                                                                                                                                                                        Returns boolean

                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                      diff --git a/docs/functions/_internal_.hasHeader.html b/docs/functions/_internal_.hasHeader.html deleted file mode 100644 index ce83bb23..00000000 --- a/docs/functions/_internal_.hasHeader.html +++ /dev/null @@ -1,7 +0,0 @@ -hasHeader | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                        Function hasHeader

                                                                                                                                                                                                                                                        • Returns true if the header identified by name is currently set in the -outgoing headers. The header name is case-insensitive.

                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                          const hasContentType = outgoingMessage.hasHeader('content-type');
-
                                                                                                                                                                                                                                                          - -

                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                          • name: string

                                                                                                                                                                                                                                                          Returns boolean

                                                                                                                                                                                                                                                          v7.7.0

                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                        diff --git a/docs/functions/_internal_.hasIn.html b/docs/functions/_internal_.hasIn.html deleted file mode 100644 index d802c1ed..00000000 --- a/docs/functions/_internal_.hasIn.html +++ /dev/null @@ -1,2 +0,0 @@ -hasIn | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                          Function hasIn

                                                                                                                                                                                                                                                          • Checks if the document includes a value at path.

                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                            Returns boolean

                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                          diff --git a/docs/functions/_internal_.httpHandler.html b/docs/functions/_internal_.httpHandler.html deleted file mode 100644 index 7a9ad4b1..00000000 --- a/docs/functions/_internal_.httpHandler.html +++ /dev/null @@ -1 +0,0 @@ -httpHandler | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                            Function httpHandler

                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                            diff --git a/docs/functions/_internal_.httpHandlerConfigs.html b/docs/functions/_internal_.httpHandlerConfigs.html deleted file mode 100644 index 9ee2b0b4..00000000 --- a/docs/functions/_internal_.httpHandlerConfigs.html +++ /dev/null @@ -1 +0,0 @@ -httpHandlerConfigs | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                              Function httpHandlerConfigs

                                                                                                                                                                                                                                                              • Returns HandlerConfig

                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                              diff --git a/docs/functions/_internal_.inRequestScope.html b/docs/functions/_internal_.inRequestScope.html deleted file mode 100644 index e6f28775..00000000 --- a/docs/functions/_internal_.inRequestScope.html +++ /dev/null @@ -1 +0,0 @@ -inRequestScope | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                Function inRequestScope

                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                diff --git a/docs/functions/_internal_.inSingletonScope.html b/docs/functions/_internal_.inSingletonScope.html deleted file mode 100644 index 0d65d90d..00000000 --- a/docs/functions/_internal_.inSingletonScope.html +++ /dev/null @@ -1 +0,0 @@ -inSingletonScope | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                  Function inSingletonScope

                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                  diff --git a/docs/functions/_internal_.inTransientScope.html b/docs/functions/_internal_.inTransientScope.html deleted file mode 100644 index 77ef9b28..00000000 --- a/docs/functions/_internal_.inTransientScope.html +++ /dev/null @@ -1 +0,0 @@ -inTransientScope | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                    Function inTransientScope

                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                    diff --git a/docs/functions/_internal_.initialiseControllers.html b/docs/functions/_internal_.initialiseControllers.html deleted file mode 100644 index 1a2282c1..00000000 --- a/docs/functions/_internal_.initialiseControllers.html +++ /dev/null @@ -1,2 +0,0 @@ -initialiseControllers | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                      Function initialiseControllers

                                                                                                                                                                                                                                                                      • Initialise all controllers and endpoints declared using decorators.

                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                        Returns Promise<void>

                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                      diff --git a/docs/functions/_internal_.iterator.html b/docs/functions/_internal_.iterator.html deleted file mode 100644 index df244cd3..00000000 --- a/docs/functions/_internal_.iterator.html +++ /dev/null @@ -1,8 +0,0 @@ -iterator | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                        Function iterator

                                                                                                                                                                                                                                                                        • The iterator created by this method gives users the option to cancel the destruction -of the stream if the for await...of loop is exited by return, break, or throw, -or if the iterator should destroy the stream if the stream emitted an error during iteration.

                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                          • Optionaloptions: { destroyOnReturn?: boolean }
                                                                                                                                                                                                                                                                            • OptionaldestroyOnReturn?: boolean

                                                                                                                                                                                                                                                                              When set to false, calling return on the async iterator, -or exiting a for await...of iteration using a break, return, or throw will not destroy the stream. -Default: true.

                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                          Returns AsyncIterator<any>

                                                                                                                                                                                                                                                                          v16.3.0

                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                        diff --git a/docs/functions/_internal_.listenerCount.html b/docs/functions/_internal_.listenerCount.html deleted file mode 100644 index b5c559e5..00000000 --- a/docs/functions/_internal_.listenerCount.html +++ /dev/null @@ -1,7 +0,0 @@ -listenerCount | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                          Function listenerCount

                                                                                                                                                                                                                                                                          • Returns the number of listeners listening for the event named eventName. -If listener is provided, it will return how many times the listener is found -in the list of the listeners of the event.

                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                            Type Parameters

                                                                                                                                                                                                                                                                            • K

                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                            • eventName: Key<K, T>

                                                                                                                                                                                                                                                                              The name of the event being listened for

                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                            • Optionallistener: Listener<K, T>

                                                                                                                                                                                                                                                                              The event handler function

                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                            Returns number

                                                                                                                                                                                                                                                                            v3.2.0

                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                          diff --git a/docs/functions/_internal_.listeners.html b/docs/functions/_internal_.listeners.html deleted file mode 100644 index 47aa189f..00000000 --- a/docs/functions/_internal_.listeners.html +++ /dev/null @@ -1,6 +0,0 @@ -listeners | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                            Function listeners

                                                                                                                                                                                                                                                                            • Returns a copy of the array of listeners for the event named eventName.

                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                              server.on('connection', (stream) => {
                                                                                                                                                                                                                                                                                console.log('someone connected!');
                                                                                                                                                                                                                                                                              });
                                                                                                                                                                                                                                                                              console.log(util.inspect(server.listeners('connection')));
                                                                                                                                                                                                                                                                              // Prints: [ [Function] ]
-
                                                                                                                                                                                                                                                                              - -

                                                                                                                                                                                                                                                                              Type Parameters

                                                                                                                                                                                                                                                                              • K

                                                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                                                              Returns Listener<K, T, Function>[]

                                                                                                                                                                                                                                                                              v0.1.26

                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                            diff --git a/docs/functions/_internal_.map.html b/docs/functions/_internal_.map.html deleted file mode 100644 index f6d94a59..00000000 --- a/docs/functions/_internal_.map.html +++ /dev/null @@ -1,6 +0,0 @@ -map | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                              Function map

                                                                                                                                                                                                                                                                              • This method allows mapping over the stream. The fn function will be called for every chunk in the stream. -If the fn function returns a promise - that promise will be awaited before being passed to the result stream.

                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                Returns Readable

                                                                                                                                                                                                                                                                                a stream mapped with the function fn.

                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                v17.4.0, v16.14.0

                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                              diff --git a/docs/functions/_internal_.next-1.html b/docs/functions/_internal_.next-1.html deleted file mode 100644 index b062b18d..00000000 --- a/docs/functions/_internal_.next-1.html +++ /dev/null @@ -1 +0,0 @@ -next | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                Function next

                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                diff --git a/docs/functions/_internal_.next-2.html b/docs/functions/_internal_.next-2.html deleted file mode 100644 index 827e63f4..00000000 --- a/docs/functions/_internal_.next-2.html +++ /dev/null @@ -1 +0,0 @@ -next | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                  Function next

                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                  diff --git a/docs/functions/_internal_.next.html b/docs/functions/_internal_.next.html deleted file mode 100644 index 3af4918e..00000000 --- a/docs/functions/_internal_.next.html +++ /dev/null @@ -1 +0,0 @@ -next | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                    Function next

                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                    diff --git a/docs/functions/_internal_.off.html b/docs/functions/_internal_.off.html deleted file mode 100644 index 9bef5b9a..00000000 --- a/docs/functions/_internal_.off.html +++ /dev/null @@ -1,3 +0,0 @@ -off | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                      Function off

                                                                                                                                                                                                                                                                                      • Alias for emitter.removeListener().

                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                        Type Parameters

                                                                                                                                                                                                                                                                                        • K

                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                        Returns this

                                                                                                                                                                                                                                                                                        v10.0.0

                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                      diff --git a/docs/functions/_internal_.on-1.html b/docs/functions/_internal_.on-1.html deleted file mode 100644 index bec28ae5..00000000 --- a/docs/functions/_internal_.on-1.html +++ /dev/null @@ -1,16 +0,0 @@ -on | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                        Function on

                                                                                                                                                                                                                                                                                        • Adds the listener function to the end of the listeners array for the event -named eventName. No checks are made to see if the listener has already -been added. Multiple calls passing the same combination of eventName and -listener will result in the listener being added, and called, multiple times.

                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                          server.on('connection', (stream) => {
                                                                                                                                                                                                                                                                                            console.log('someone connected!');
                                                                                                                                                                                                                                                                                          });
-
                                                                                                                                                                                                                                                                                          - -

                                                                                                                                                                                                                                                                                          Returns a reference to the EventEmitter, so that calls can be chained.

                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                          By default, event listeners are invoked in the order they are added. The emitter.prependListener() method can be used as an alternative to add the -event listener to the beginning of the listeners array.

                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                          import { EventEmitter } from 'node:events';
                                                                                                                                                                                                                                                                                          const myEE = new EventEmitter();
                                                                                                                                                                                                                                                                                          myEE.on('foo', () => console.log('a'));
                                                                                                                                                                                                                                                                                          myEE.prependListener('foo', () => console.log('b'));
                                                                                                                                                                                                                                                                                          myEE.emit('foo');
                                                                                                                                                                                                                                                                                          // Prints:
                                                                                                                                                                                                                                                                                          //   b
                                                                                                                                                                                                                                                                                          //   a
-
                                                                                                                                                                                                                                                                                          - -

                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                          • event: "close"
                                                                                                                                                                                                                                                                                          • listener: () => void

                                                                                                                                                                                                                                                                                            The callback function

                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                          Returns this

                                                                                                                                                                                                                                                                                          v0.1.101

                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                          • event: "data"
                                                                                                                                                                                                                                                                                          • listener: (chunk: any) => void

                                                                                                                                                                                                                                                                                          Returns this

                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                          • event: "drain"
                                                                                                                                                                                                                                                                                          • listener: () => void

                                                                                                                                                                                                                                                                                          Returns this

                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                          • event: "end"
                                                                                                                                                                                                                                                                                          • listener: () => void

                                                                                                                                                                                                                                                                                          Returns this

                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                          • event: "error"
                                                                                                                                                                                                                                                                                          • listener: (err: Error) => void

                                                                                                                                                                                                                                                                                          Returns this

                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                          • event: "finish"
                                                                                                                                                                                                                                                                                          • listener: () => void

                                                                                                                                                                                                                                                                                          Returns this

                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                          • event: "pause"
                                                                                                                                                                                                                                                                                          • listener: () => void

                                                                                                                                                                                                                                                                                          Returns this

                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                          • event: "pipe"
                                                                                                                                                                                                                                                                                          • listener: (src: Readable) => void

                                                                                                                                                                                                                                                                                          Returns this

                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                          • event: "readable"
                                                                                                                                                                                                                                                                                          • listener: () => void

                                                                                                                                                                                                                                                                                          Returns this

                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                          • event: "resume"
                                                                                                                                                                                                                                                                                          • listener: () => void

                                                                                                                                                                                                                                                                                          Returns this

                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                          • event: "unpipe"
                                                                                                                                                                                                                                                                                          • listener: (src: Readable) => void

                                                                                                                                                                                                                                                                                          Returns this

                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                          • event: string | symbol
                                                                                                                                                                                                                                                                                          • listener: (...args: any[]) => void

                                                                                                                                                                                                                                                                                          Returns this

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                        diff --git a/docs/functions/_internal_.on-2.html b/docs/functions/_internal_.on-2.html deleted file mode 100644 index a06bd4aa..00000000 --- a/docs/functions/_internal_.on-2.html +++ /dev/null @@ -1,16 +0,0 @@ -on | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                          Function on

                                                                                                                                                                                                                                                                                          • Adds the listener function to the end of the listeners array for the event -named eventName. No checks are made to see if the listener has already -been added. Multiple calls passing the same combination of eventName and -listener will result in the listener being added, and called, multiple times.

                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                            server.on('connection', (stream) => {
                                                                                                                                                                                                                                                                                              console.log('someone connected!');
                                                                                                                                                                                                                                                                                            });
-
                                                                                                                                                                                                                                                                                            - -

                                                                                                                                                                                                                                                                                            Returns a reference to the EventEmitter, so that calls can be chained.

                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                            By default, event listeners are invoked in the order they are added. The emitter.prependListener() method can be used as an alternative to add the -event listener to the beginning of the listeners array.

                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                            import { EventEmitter } from 'node:events';
                                                                                                                                                                                                                                                                                            const myEE = new EventEmitter();
                                                                                                                                                                                                                                                                                            myEE.on('foo', () => console.log('a'));
                                                                                                                                                                                                                                                                                            myEE.prependListener('foo', () => console.log('b'));
                                                                                                                                                                                                                                                                                            myEE.emit('foo');
                                                                                                                                                                                                                                                                                            // Prints:
                                                                                                                                                                                                                                                                                            //   b
                                                                                                                                                                                                                                                                                            //   a
-
                                                                                                                                                                                                                                                                                            - -

                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                            • event: "close"
                                                                                                                                                                                                                                                                                            • listener: () => void

                                                                                                                                                                                                                                                                                              The callback function

                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                            Returns this

                                                                                                                                                                                                                                                                                            v0.1.101

                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                            • event: "data"
                                                                                                                                                                                                                                                                                            • listener: (chunk: any) => void

                                                                                                                                                                                                                                                                                            Returns this

                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                            • event: "end"
                                                                                                                                                                                                                                                                                            • listener: () => void

                                                                                                                                                                                                                                                                                            Returns this

                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                            • event: "error"
                                                                                                                                                                                                                                                                                            • listener: (err: Error) => void

                                                                                                                                                                                                                                                                                            Returns this

                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                            • event: "pause"
                                                                                                                                                                                                                                                                                            • listener: () => void

                                                                                                                                                                                                                                                                                            Returns this

                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                            • event: "readable"
                                                                                                                                                                                                                                                                                            • listener: () => void

                                                                                                                                                                                                                                                                                            Returns this

                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                            • event: "resume"
                                                                                                                                                                                                                                                                                            • listener: () => void

                                                                                                                                                                                                                                                                                            Returns this

                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                            • event: string | symbol
                                                                                                                                                                                                                                                                                            • listener: (...args: any[]) => void

                                                                                                                                                                                                                                                                                            Returns this

                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                          diff --git a/docs/functions/_internal_.on-3.html b/docs/functions/_internal_.on-3.html deleted file mode 100644 index 7536fe48..00000000 --- a/docs/functions/_internal_.on-3.html +++ /dev/null @@ -1,16 +0,0 @@ -on | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                            Function on

                                                                                                                                                                                                                                                                                            • Adds the listener function to the end of the listeners array for the event -named eventName. No checks are made to see if the listener has already -been added. Multiple calls passing the same combination of eventName and -listener will result in the listener being added, and called, multiple times.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              server.on('connection', (stream) => {
                                                                                                                                                                                                                                                                                                console.log('someone connected!');
                                                                                                                                                                                                                                                                                              });
-
                                                                                                                                                                                                                                                                                              - -

                                                                                                                                                                                                                                                                                              Returns a reference to the EventEmitter, so that calls can be chained.

                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                              By default, event listeners are invoked in the order they are added. The emitter.prependListener() method can be used as an alternative to add the -event listener to the beginning of the listeners array.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              import { EventEmitter } from 'node:events';
                                                                                                                                                                                                                                                                                              const myEE = new EventEmitter();
                                                                                                                                                                                                                                                                                              myEE.on('foo', () => console.log('a'));
                                                                                                                                                                                                                                                                                              myEE.prependListener('foo', () => console.log('b'));
                                                                                                                                                                                                                                                                                              myEE.emit('foo');
                                                                                                                                                                                                                                                                                              // Prints:
                                                                                                                                                                                                                                                                                              //   b
                                                                                                                                                                                                                                                                                              //   a
-
                                                                                                                                                                                                                                                                                              - -

                                                                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                                                                              • event: "close"
                                                                                                                                                                                                                                                                                              • listener: () => void

                                                                                                                                                                                                                                                                                                The callback function

                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                              Returns this

                                                                                                                                                                                                                                                                                              v0.1.101

                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                                                                              • event: "drain"
                                                                                                                                                                                                                                                                                              • listener: () => void

                                                                                                                                                                                                                                                                                              Returns this

                                                                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                                                                              • event: "error"
                                                                                                                                                                                                                                                                                              • listener: (err: Error) => void

                                                                                                                                                                                                                                                                                              Returns this

                                                                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                                                                              • event: "finish"
                                                                                                                                                                                                                                                                                              • listener: () => void

                                                                                                                                                                                                                                                                                              Returns this

                                                                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                                                                              • event: "pipe"
                                                                                                                                                                                                                                                                                              • listener: (src: Readable) => void

                                                                                                                                                                                                                                                                                              Returns this

                                                                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                                                                              • event: "unpipe"
                                                                                                                                                                                                                                                                                              • listener: (src: Readable) => void

                                                                                                                                                                                                                                                                                              Returns this

                                                                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                                                                              • event: string | symbol
                                                                                                                                                                                                                                                                                              • listener: (...args: any[]) => void

                                                                                                                                                                                                                                                                                              Returns this

                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                            diff --git a/docs/functions/_internal_.on.html b/docs/functions/_internal_.on.html deleted file mode 100644 index c78c6156..00000000 --- a/docs/functions/_internal_.on.html +++ /dev/null @@ -1,17 +0,0 @@ -on | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                              Function on

                                                                                                                                                                                                                                                                                              • Adds the listener function to the end of the listeners array for the event -named eventName. No checks are made to see if the listener has already -been added. Multiple calls passing the same combination of eventName and -listener will result in the listener being added, and called, multiple times.

                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                server.on('connection', (stream) => {
                                                                                                                                                                                                                                                                                                  console.log('someone connected!');
                                                                                                                                                                                                                                                                                                });
-
                                                                                                                                                                                                                                                                                                - -

                                                                                                                                                                                                                                                                                                Returns a reference to the EventEmitter, so that calls can be chained.

                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                By default, event listeners are invoked in the order they are added. The emitter.prependListener() method can be used as an alternative to add the -event listener to the beginning of the listeners array.

                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                import { EventEmitter } from 'node:events';
                                                                                                                                                                                                                                                                                                const myEE = new EventEmitter();
                                                                                                                                                                                                                                                                                                myEE.on('foo', () => console.log('a'));
                                                                                                                                                                                                                                                                                                myEE.prependListener('foo', () => console.log('b'));
                                                                                                                                                                                                                                                                                                myEE.emit('foo');
                                                                                                                                                                                                                                                                                                // Prints:
                                                                                                                                                                                                                                                                                                //   b
                                                                                                                                                                                                                                                                                                //   a
-
                                                                                                                                                                                                                                                                                                - -

                                                                                                                                                                                                                                                                                                Type Parameters

                                                                                                                                                                                                                                                                                                • K

                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                • eventName: Key<K, T>

                                                                                                                                                                                                                                                                                                  The name of the event.

                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                • listener: Listener<K, T>

                                                                                                                                                                                                                                                                                                  The callback function

                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                Returns this

                                                                                                                                                                                                                                                                                                v0.1.101

                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                              diff --git a/docs/functions/_internal_.onActivation.html b/docs/functions/_internal_.onActivation.html deleted file mode 100644 index e74c6b76..00000000 --- a/docs/functions/_internal_.onActivation.html +++ /dev/null @@ -1 +0,0 @@ -onActivation | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                Function onActivation

                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                diff --git a/docs/functions/_internal_.once-1.html b/docs/functions/_internal_.once-1.html deleted file mode 100644 index 8f052351..00000000 --- a/docs/functions/_internal_.once-1.html +++ /dev/null @@ -1,14 +0,0 @@ -once | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                  Function once

                                                                                                                                                                                                                                                                                                  • Adds a one-time listener function for the event named eventName. The -next time eventName is triggered, this listener is removed and then invoked.

                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                    server.once('connection', (stream) => {
                                                                                                                                                                                                                                                                                                      console.log('Ah, we have our first user!');
                                                                                                                                                                                                                                                                                                    });
-
                                                                                                                                                                                                                                                                                                    - -

                                                                                                                                                                                                                                                                                                    Returns a reference to the EventEmitter, so that calls can be chained.

                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                    By default, event listeners are invoked in the order they are added. The emitter.prependOnceListener() method can be used as an alternative to add the -event listener to the beginning of the listeners array.

                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                    import { EventEmitter } from 'node:events';
                                                                                                                                                                                                                                                                                                    const myEE = new EventEmitter();
                                                                                                                                                                                                                                                                                                    myEE.once('foo', () => console.log('a'));
                                                                                                                                                                                                                                                                                                    myEE.prependOnceListener('foo', () => console.log('b'));
                                                                                                                                                                                                                                                                                                    myEE.emit('foo');
                                                                                                                                                                                                                                                                                                    // Prints:
                                                                                                                                                                                                                                                                                                    //   b
                                                                                                                                                                                                                                                                                                    //   a
-
                                                                                                                                                                                                                                                                                                    - -

                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                    • event: "close"
                                                                                                                                                                                                                                                                                                    • listener: () => void

                                                                                                                                                                                                                                                                                                      The callback function

                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                    Returns this

                                                                                                                                                                                                                                                                                                    v0.3.0

                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                    • event: "data"
                                                                                                                                                                                                                                                                                                    • listener: (chunk: any) => void

                                                                                                                                                                                                                                                                                                    Returns this

                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                    • event: "drain"
                                                                                                                                                                                                                                                                                                    • listener: () => void

                                                                                                                                                                                                                                                                                                    Returns this

                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                    • event: "end"
                                                                                                                                                                                                                                                                                                    • listener: () => void

                                                                                                                                                                                                                                                                                                    Returns this

                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                    • event: "error"
                                                                                                                                                                                                                                                                                                    • listener: (err: Error) => void

                                                                                                                                                                                                                                                                                                    Returns this

                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                    • event: "finish"
                                                                                                                                                                                                                                                                                                    • listener: () => void

                                                                                                                                                                                                                                                                                                    Returns this

                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                    • event: "pause"
                                                                                                                                                                                                                                                                                                    • listener: () => void

                                                                                                                                                                                                                                                                                                    Returns this

                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                    • event: "pipe"
                                                                                                                                                                                                                                                                                                    • listener: (src: Readable) => void

                                                                                                                                                                                                                                                                                                    Returns this

                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                    • event: "readable"
                                                                                                                                                                                                                                                                                                    • listener: () => void

                                                                                                                                                                                                                                                                                                    Returns this

                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                    • event: "resume"
                                                                                                                                                                                                                                                                                                    • listener: () => void

                                                                                                                                                                                                                                                                                                    Returns this

                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                    • event: "unpipe"
                                                                                                                                                                                                                                                                                                    • listener: (src: Readable) => void

                                                                                                                                                                                                                                                                                                    Returns this

                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                    • event: string | symbol
                                                                                                                                                                                                                                                                                                    • listener: (...args: any[]) => void

                                                                                                                                                                                                                                                                                                    Returns this

                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                                  diff --git a/docs/functions/_internal_.once-2.html b/docs/functions/_internal_.once-2.html deleted file mode 100644 index 51d93cee..00000000 --- a/docs/functions/_internal_.once-2.html +++ /dev/null @@ -1,14 +0,0 @@ -once | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                    Function once

                                                                                                                                                                                                                                                                                                    • Adds a one-time listener function for the event named eventName. The -next time eventName is triggered, this listener is removed and then invoked.

                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                      server.once('connection', (stream) => {
                                                                                                                                                                                                                                                                                                        console.log('Ah, we have our first user!');
                                                                                                                                                                                                                                                                                                      });
-
                                                                                                                                                                                                                                                                                                      - -

                                                                                                                                                                                                                                                                                                      Returns a reference to the EventEmitter, so that calls can be chained.

                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                      By default, event listeners are invoked in the order they are added. The emitter.prependOnceListener() method can be used as an alternative to add the -event listener to the beginning of the listeners array.

                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                      import { EventEmitter } from 'node:events';
                                                                                                                                                                                                                                                                                                      const myEE = new EventEmitter();
                                                                                                                                                                                                                                                                                                      myEE.once('foo', () => console.log('a'));
                                                                                                                                                                                                                                                                                                      myEE.prependOnceListener('foo', () => console.log('b'));
                                                                                                                                                                                                                                                                                                      myEE.emit('foo');
                                                                                                                                                                                                                                                                                                      // Prints:
                                                                                                                                                                                                                                                                                                      //   b
                                                                                                                                                                                                                                                                                                      //   a
-
                                                                                                                                                                                                                                                                                                      - -

                                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                                      • event: "close"
                                                                                                                                                                                                                                                                                                      • listener: () => void

                                                                                                                                                                                                                                                                                                        The callback function

                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                      Returns this

                                                                                                                                                                                                                                                                                                      v0.3.0

                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                                                                                                                      • event: "data"
                                                                                                                                                                                                                                                                                                      • listener: (chunk: any) => void

                                                                                                                                                                                                                                                                                                      Returns this

                                                                                                                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                                                                                                                      • event: "end"
                                                                                                                                                                                                                                                                                                      • listener: () => void

                                                                                                                                                                                                                                                                                                      Returns this

                                                                                                                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                                                                                                                      • event: "error"
                                                                                                                                                                                                                                                                                                      • listener: (err: Error) => void

                                                                                                                                                                                                                                                                                                      Returns this

                                                                                                                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                                                                                                                      • event: "pause"
                                                                                                                                                                                                                                                                                                      • listener: () => void

                                                                                                                                                                                                                                                                                                      Returns this

                                                                                                                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                                                                                                                      • event: "readable"
                                                                                                                                                                                                                                                                                                      • listener: () => void

                                                                                                                                                                                                                                                                                                      Returns this

                                                                                                                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                                                                                                                      • event: "resume"
                                                                                                                                                                                                                                                                                                      • listener: () => void

                                                                                                                                                                                                                                                                                                      Returns this

                                                                                                                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                                                                                                                      • event: string | symbol
                                                                                                                                                                                                                                                                                                      • listener: (...args: any[]) => void

                                                                                                                                                                                                                                                                                                      Returns this

                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                    diff --git a/docs/functions/_internal_.once-3.html b/docs/functions/_internal_.once-3.html deleted file mode 100644 index f87bc034..00000000 --- a/docs/functions/_internal_.once-3.html +++ /dev/null @@ -1,14 +0,0 @@ -once | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                      Function once

                                                                                                                                                                                                                                                                                                      • Adds a one-time listener function for the event named eventName. The -next time eventName is triggered, this listener is removed and then invoked.

                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                        server.once('connection', (stream) => {
                                                                                                                                                                                                                                                                                                          console.log('Ah, we have our first user!');
                                                                                                                                                                                                                                                                                                        });
-
                                                                                                                                                                                                                                                                                                        - -

                                                                                                                                                                                                                                                                                                        Returns a reference to the EventEmitter, so that calls can be chained.

                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                        By default, event listeners are invoked in the order they are added. The emitter.prependOnceListener() method can be used as an alternative to add the -event listener to the beginning of the listeners array.

                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                        import { EventEmitter } from 'node:events';
                                                                                                                                                                                                                                                                                                        const myEE = new EventEmitter();
                                                                                                                                                                                                                                                                                                        myEE.once('foo', () => console.log('a'));
                                                                                                                                                                                                                                                                                                        myEE.prependOnceListener('foo', () => console.log('b'));
                                                                                                                                                                                                                                                                                                        myEE.emit('foo');
                                                                                                                                                                                                                                                                                                        // Prints:
                                                                                                                                                                                                                                                                                                        //   b
                                                                                                                                                                                                                                                                                                        //   a
-
                                                                                                                                                                                                                                                                                                        - -

                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                        • event: "close"
                                                                                                                                                                                                                                                                                                        • listener: () => void

                                                                                                                                                                                                                                                                                                          The callback function

                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                        Returns this

                                                                                                                                                                                                                                                                                                        v0.3.0

                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                        • event: "drain"
                                                                                                                                                                                                                                                                                                        • listener: () => void

                                                                                                                                                                                                                                                                                                        Returns this

                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                        • event: "error"
                                                                                                                                                                                                                                                                                                        • listener: (err: Error) => void

                                                                                                                                                                                                                                                                                                        Returns this

                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                        • event: "finish"
                                                                                                                                                                                                                                                                                                        • listener: () => void

                                                                                                                                                                                                                                                                                                        Returns this

                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                        • event: "pipe"
                                                                                                                                                                                                                                                                                                        • listener: (src: Readable) => void

                                                                                                                                                                                                                                                                                                        Returns this

                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                        • event: "unpipe"
                                                                                                                                                                                                                                                                                                        • listener: (src: Readable) => void

                                                                                                                                                                                                                                                                                                        Returns this

                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                        • event: string | symbol
                                                                                                                                                                                                                                                                                                        • listener: (...args: any[]) => void

                                                                                                                                                                                                                                                                                                        Returns this

                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                      diff --git a/docs/functions/_internal_.once.html b/docs/functions/_internal_.once.html deleted file mode 100644 index 26de05f8..00000000 --- a/docs/functions/_internal_.once.html +++ /dev/null @@ -1,15 +0,0 @@ -once | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                        Function once

                                                                                                                                                                                                                                                                                                        • Adds a one-time listener function for the event named eventName. The -next time eventName is triggered, this listener is removed and then invoked.

                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          server.once('connection', (stream) => {
                                                                                                                                                                                                                                                                                                            console.log('Ah, we have our first user!');
                                                                                                                                                                                                                                                                                                          });
-
                                                                                                                                                                                                                                                                                                          - -

                                                                                                                                                                                                                                                                                                          Returns a reference to the EventEmitter, so that calls can be chained.

                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                          By default, event listeners are invoked in the order they are added. The emitter.prependOnceListener() method can be used as an alternative to add the -event listener to the beginning of the listeners array.

                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          import { EventEmitter } from 'node:events';
                                                                                                                                                                                                                                                                                                          const myEE = new EventEmitter();
                                                                                                                                                                                                                                                                                                          myEE.once('foo', () => console.log('a'));
                                                                                                                                                                                                                                                                                                          myEE.prependOnceListener('foo', () => console.log('b'));
                                                                                                                                                                                                                                                                                                          myEE.emit('foo');
                                                                                                                                                                                                                                                                                                          // Prints:
                                                                                                                                                                                                                                                                                                          //   b
                                                                                                                                                                                                                                                                                                          //   a
-
                                                                                                                                                                                                                                                                                                          - -

                                                                                                                                                                                                                                                                                                          Type Parameters

                                                                                                                                                                                                                                                                                                          • K

                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                          • eventName: Key<K, T>

                                                                                                                                                                                                                                                                                                            The name of the event.

                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                          • listener: Listener<K, T>

                                                                                                                                                                                                                                                                                                            The callback function

                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                          Returns this

                                                                                                                                                                                                                                                                                                          v0.3.0

                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                        diff --git a/docs/functions/_internal_.pause-1.html b/docs/functions/_internal_.pause-1.html deleted file mode 100644 index 525e7476..00000000 --- a/docs/functions/_internal_.pause-1.html +++ /dev/null @@ -1,9 +0,0 @@ -pause | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                          Function pause

                                                                                                                                                                                                                                                                                                          • The readable.pause() method will cause a stream in flowing mode to stop -emitting 'data' events, switching out of flowing mode. Any data that -becomes available will remain in the internal buffer.

                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                            const readable = getReadableStreamSomehow();
                                                                                                                                                                                                                                                                                                            readable.on('data', (chunk) => {
                                                                                                                                                                                                                                                                                                              console.log(`Received ${chunk.length} bytes of data.`);
                                                                                                                                                                                                                                                                                                              readable.pause();
                                                                                                                                                                                                                                                                                                              console.log('There will be no additional data for 1 second.');
                                                                                                                                                                                                                                                                                                              setTimeout(() => {
                                                                                                                                                                                                                                                                                                                console.log('Now data will start flowing again.');
                                                                                                                                                                                                                                                                                                                readable.resume();
                                                                                                                                                                                                                                                                                                              }, 1000);
                                                                                                                                                                                                                                                                                                            });
-
                                                                                                                                                                                                                                                                                                            - -

                                                                                                                                                                                                                                                                                                            The readable.pause() method has no effect if there is a 'readable' event listener.

                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                            Returns this

                                                                                                                                                                                                                                                                                                            v0.9.4

                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                          diff --git a/docs/functions/_internal_.pause.html b/docs/functions/_internal_.pause.html deleted file mode 100644 index 42508677..00000000 --- a/docs/functions/_internal_.pause.html +++ /dev/null @@ -1 +0,0 @@ -pause | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                            Function pause

                                                                                                                                                                                                                                                                                                            • Returns this

                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                            diff --git a/docs/functions/_internal_.pipe-1.html b/docs/functions/_internal_.pipe-1.html deleted file mode 100644 index a699ac51..00000000 --- a/docs/functions/_internal_.pipe-1.html +++ /dev/null @@ -1 +0,0 @@ -pipe | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                              Function pipe

                                                                                                                                                                                                                                                                                                              • Type Parameters

                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                • destination: T
                                                                                                                                                                                                                                                                                                                • Optionaloptions: { end?: boolean }

                                                                                                                                                                                                                                                                                                                Returns T

                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                              diff --git a/docs/functions/_internal_.pipe.html b/docs/functions/_internal_.pipe.html deleted file mode 100644 index 48bbd691..00000000 --- a/docs/functions/_internal_.pipe.html +++ /dev/null @@ -1 +0,0 @@ -pipe | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                Function pipe

                                                                                                                                                                                                                                                                                                                • Type Parameters

                                                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                                                  • destination: T
                                                                                                                                                                                                                                                                                                                  • Optionaloptions: { end?: boolean }

                                                                                                                                                                                                                                                                                                                  Returns T

                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                diff --git a/docs/functions/_internal_.prependListener-1.html b/docs/functions/_internal_.prependListener-1.html deleted file mode 100644 index d86af261..00000000 --- a/docs/functions/_internal_.prependListener-1.html +++ /dev/null @@ -1,11 +0,0 @@ -prependListener | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                  Function prependListener

                                                                                                                                                                                                                                                                                                                  • Adds the listener function to the beginning of the listeners array for the -event named eventName. No checks are made to see if the listener has -already been added. Multiple calls passing the same combination of eventName -and listener will result in the listener being added, and called, multiple times.

                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                    server.prependListener('connection', (stream) => {
                                                                                                                                                                                                                                                                                                                      console.log('someone connected!');
                                                                                                                                                                                                                                                                                                                    });
-
                                                                                                                                                                                                                                                                                                                    - -

                                                                                                                                                                                                                                                                                                                    Returns a reference to the EventEmitter, so that calls can be chained.

                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                    • event: "close"
                                                                                                                                                                                                                                                                                                                    • listener: () => void

                                                                                                                                                                                                                                                                                                                      The callback function

                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                    Returns this

                                                                                                                                                                                                                                                                                                                    v6.0.0

                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                                    • event: "data"
                                                                                                                                                                                                                                                                                                                    • listener: (chunk: any) => void

                                                                                                                                                                                                                                                                                                                    Returns this

                                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                                    • event: "drain"
                                                                                                                                                                                                                                                                                                                    • listener: () => void

                                                                                                                                                                                                                                                                                                                    Returns this

                                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                                    • event: "end"
                                                                                                                                                                                                                                                                                                                    • listener: () => void

                                                                                                                                                                                                                                                                                                                    Returns this

                                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                                    • event: "error"
                                                                                                                                                                                                                                                                                                                    • listener: (err: Error) => void

                                                                                                                                                                                                                                                                                                                    Returns this

                                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                                    • event: "finish"
                                                                                                                                                                                                                                                                                                                    • listener: () => void

                                                                                                                                                                                                                                                                                                                    Returns this

                                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                                    • event: "pause"
                                                                                                                                                                                                                                                                                                                    • listener: () => void

                                                                                                                                                                                                                                                                                                                    Returns this

                                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                                    • event: "pipe"
                                                                                                                                                                                                                                                                                                                    • listener: (src: Readable) => void

                                                                                                                                                                                                                                                                                                                    Returns this

                                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                                    • event: "readable"
                                                                                                                                                                                                                                                                                                                    • listener: () => void

                                                                                                                                                                                                                                                                                                                    Returns this

                                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                                    • event: "resume"
                                                                                                                                                                                                                                                                                                                    • listener: () => void

                                                                                                                                                                                                                                                                                                                    Returns this

                                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                                    • event: "unpipe"
                                                                                                                                                                                                                                                                                                                    • listener: (src: Readable) => void

                                                                                                                                                                                                                                                                                                                    Returns this

                                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                                    • event: string | symbol
                                                                                                                                                                                                                                                                                                                    • listener: (...args: any[]) => void

                                                                                                                                                                                                                                                                                                                    Returns this

                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                                                  diff --git a/docs/functions/_internal_.prependListener-2.html b/docs/functions/_internal_.prependListener-2.html deleted file mode 100644 index fa17a6f2..00000000 --- a/docs/functions/_internal_.prependListener-2.html +++ /dev/null @@ -1,11 +0,0 @@ -prependListener | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                    Function prependListener

                                                                                                                                                                                                                                                                                                                    • Adds the listener function to the beginning of the listeners array for the -event named eventName. No checks are made to see if the listener has -already been added. Multiple calls passing the same combination of eventName -and listener will result in the listener being added, and called, multiple times.

                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                      server.prependListener('connection', (stream) => {
                                                                                                                                                                                                                                                                                                                        console.log('someone connected!');
                                                                                                                                                                                                                                                                                                                      });
-
                                                                                                                                                                                                                                                                                                                      - -

                                                                                                                                                                                                                                                                                                                      Returns a reference to the EventEmitter, so that calls can be chained.

                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                                                      • event: "close"
                                                                                                                                                                                                                                                                                                                      • listener: () => void

                                                                                                                                                                                                                                                                                                                        The callback function

                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                      Returns this

                                                                                                                                                                                                                                                                                                                      v6.0.0

                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                                                                                                                                      • event: "data"
                                                                                                                                                                                                                                                                                                                      • listener: (chunk: any) => void

                                                                                                                                                                                                                                                                                                                      Returns this

                                                                                                                                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                                                                                                                                      • event: "end"
                                                                                                                                                                                                                                                                                                                      • listener: () => void

                                                                                                                                                                                                                                                                                                                      Returns this

                                                                                                                                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                                                                                                                                      • event: "error"
                                                                                                                                                                                                                                                                                                                      • listener: (err: Error) => void

                                                                                                                                                                                                                                                                                                                      Returns this

                                                                                                                                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                                                                                                                                      • event: "pause"
                                                                                                                                                                                                                                                                                                                      • listener: () => void

                                                                                                                                                                                                                                                                                                                      Returns this

                                                                                                                                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                                                                                                                                      • event: "readable"
                                                                                                                                                                                                                                                                                                                      • listener: () => void

                                                                                                                                                                                                                                                                                                                      Returns this

                                                                                                                                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                                                                                                                                      • event: "resume"
                                                                                                                                                                                                                                                                                                                      • listener: () => void

                                                                                                                                                                                                                                                                                                                      Returns this

                                                                                                                                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                                                                                                                                      • event: string | symbol
                                                                                                                                                                                                                                                                                                                      • listener: (...args: any[]) => void

                                                                                                                                                                                                                                                                                                                      Returns this

                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                    diff --git a/docs/functions/_internal_.prependListener-3.html b/docs/functions/_internal_.prependListener-3.html deleted file mode 100644 index 5ab976c5..00000000 --- a/docs/functions/_internal_.prependListener-3.html +++ /dev/null @@ -1,11 +0,0 @@ -prependListener | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                      Function prependListener

                                                                                                                                                                                                                                                                                                                      • Adds the listener function to the beginning of the listeners array for the -event named eventName. No checks are made to see if the listener has -already been added. Multiple calls passing the same combination of eventName -and listener will result in the listener being added, and called, multiple times.

                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                        server.prependListener('connection', (stream) => {
                                                                                                                                                                                                                                                                                                                          console.log('someone connected!');
                                                                                                                                                                                                                                                                                                                        });
-
                                                                                                                                                                                                                                                                                                                        - -

                                                                                                                                                                                                                                                                                                                        Returns a reference to the EventEmitter, so that calls can be chained.

                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                        • event: "close"
                                                                                                                                                                                                                                                                                                                        • listener: () => void

                                                                                                                                                                                                                                                                                                                          The callback function

                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                        Returns this

                                                                                                                                                                                                                                                                                                                        v6.0.0

                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                        • event: "drain"
                                                                                                                                                                                                                                                                                                                        • listener: () => void

                                                                                                                                                                                                                                                                                                                        Returns this

                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                        • event: "error"
                                                                                                                                                                                                                                                                                                                        • listener: (err: Error) => void

                                                                                                                                                                                                                                                                                                                        Returns this

                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                        • event: "finish"
                                                                                                                                                                                                                                                                                                                        • listener: () => void

                                                                                                                                                                                                                                                                                                                        Returns this

                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                        • event: "pipe"
                                                                                                                                                                                                                                                                                                                        • listener: (src: Readable) => void

                                                                                                                                                                                                                                                                                                                        Returns this

                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                        • event: "unpipe"
                                                                                                                                                                                                                                                                                                                        • listener: (src: Readable) => void

                                                                                                                                                                                                                                                                                                                        Returns this

                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                        • event: string | symbol
                                                                                                                                                                                                                                                                                                                        • listener: (...args: any[]) => void

                                                                                                                                                                                                                                                                                                                        Returns this

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                      diff --git a/docs/functions/_internal_.prependListener.html b/docs/functions/_internal_.prependListener.html deleted file mode 100644 index 35a65f8b..00000000 --- a/docs/functions/_internal_.prependListener.html +++ /dev/null @@ -1,12 +0,0 @@ -prependListener | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                        Function prependListener

                                                                                                                                                                                                                                                                                                                        • Adds the listener function to the beginning of the listeners array for the -event named eventName. No checks are made to see if the listener has -already been added. Multiple calls passing the same combination of eventName -and listener will result in the listener being added, and called, multiple times.

                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                          server.prependListener('connection', (stream) => {
                                                                                                                                                                                                                                                                                                                            console.log('someone connected!');
                                                                                                                                                                                                                                                                                                                          });
-
                                                                                                                                                                                                                                                                                                                          - -

                                                                                                                                                                                                                                                                                                                          Returns a reference to the EventEmitter, so that calls can be chained.

                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                          Type Parameters

                                                                                                                                                                                                                                                                                                                          • K

                                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                                          • eventName: Key<K, T>

                                                                                                                                                                                                                                                                                                                            The name of the event.

                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                          • listener: Listener<K, T>

                                                                                                                                                                                                                                                                                                                            The callback function

                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                          Returns this

                                                                                                                                                                                                                                                                                                                          v6.0.0

                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                        diff --git a/docs/functions/_internal_.prependOnceListener-1.html b/docs/functions/_internal_.prependOnceListener-1.html deleted file mode 100644 index c28eba98..00000000 --- a/docs/functions/_internal_.prependOnceListener-1.html +++ /dev/null @@ -1,9 +0,0 @@ -prependOnceListener | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                          Function prependOnceListener

                                                                                                                                                                                                                                                                                                                          • Adds a one-timelistener function for the event named eventName to the beginning of the listeners array. The next time eventName is triggered, this -listener is removed, and then invoked.

                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                            server.prependOnceListener('connection', (stream) => {
                                                                                                                                                                                                                                                                                                                              console.log('Ah, we have our first user!');
                                                                                                                                                                                                                                                                                                                            });
-
                                                                                                                                                                                                                                                                                                                            - -

                                                                                                                                                                                                                                                                                                                            Returns a reference to the EventEmitter, so that calls can be chained.

                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                            • event: "close"
                                                                                                                                                                                                                                                                                                                            • listener: () => void

                                                                                                                                                                                                                                                                                                                              The callback function

                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                            Returns this

                                                                                                                                                                                                                                                                                                                            v6.0.0

                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                            • event: "data"
                                                                                                                                                                                                                                                                                                                            • listener: (chunk: any) => void

                                                                                                                                                                                                                                                                                                                            Returns this

                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                            • event: "drain"
                                                                                                                                                                                                                                                                                                                            • listener: () => void

                                                                                                                                                                                                                                                                                                                            Returns this

                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                            • event: "end"
                                                                                                                                                                                                                                                                                                                            • listener: () => void

                                                                                                                                                                                                                                                                                                                            Returns this

                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                            • event: "error"
                                                                                                                                                                                                                                                                                                                            • listener: (err: Error) => void

                                                                                                                                                                                                                                                                                                                            Returns this

                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                            • event: "finish"
                                                                                                                                                                                                                                                                                                                            • listener: () => void

                                                                                                                                                                                                                                                                                                                            Returns this

                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                            • event: "pause"
                                                                                                                                                                                                                                                                                                                            • listener: () => void

                                                                                                                                                                                                                                                                                                                            Returns this

                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                            • event: "pipe"
                                                                                                                                                                                                                                                                                                                            • listener: (src: Readable) => void

                                                                                                                                                                                                                                                                                                                            Returns this

                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                            • event: "readable"
                                                                                                                                                                                                                                                                                                                            • listener: () => void

                                                                                                                                                                                                                                                                                                                            Returns this

                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                            • event: "resume"
                                                                                                                                                                                                                                                                                                                            • listener: () => void

                                                                                                                                                                                                                                                                                                                            Returns this

                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                            • event: "unpipe"
                                                                                                                                                                                                                                                                                                                            • listener: (src: Readable) => void

                                                                                                                                                                                                                                                                                                                            Returns this

                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                            • event: string | symbol
                                                                                                                                                                                                                                                                                                                            • listener: (...args: any[]) => void

                                                                                                                                                                                                                                                                                                                            Returns this

                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                          diff --git a/docs/functions/_internal_.prependOnceListener-2.html b/docs/functions/_internal_.prependOnceListener-2.html deleted file mode 100644 index b3e0b4a7..00000000 --- a/docs/functions/_internal_.prependOnceListener-2.html +++ /dev/null @@ -1,9 +0,0 @@ -prependOnceListener | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                            Function prependOnceListener

                                                                                                                                                                                                                                                                                                                            • Adds a one-timelistener function for the event named eventName to the beginning of the listeners array. The next time eventName is triggered, this -listener is removed, and then invoked.

                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                              server.prependOnceListener('connection', (stream) => {
                                                                                                                                                                                                                                                                                                                                console.log('Ah, we have our first user!');
                                                                                                                                                                                                                                                                                                                              });
-
                                                                                                                                                                                                                                                                                                                              - -

                                                                                                                                                                                                                                                                                                                              Returns a reference to the EventEmitter, so that calls can be chained.

                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                                                                                                              • event: "close"
                                                                                                                                                                                                                                                                                                                              • listener: () => void

                                                                                                                                                                                                                                                                                                                                The callback function

                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                              Returns this

                                                                                                                                                                                                                                                                                                                              v6.0.0

                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                                                                                                              • event: "data"
                                                                                                                                                                                                                                                                                                                              • listener: (chunk: any) => void

                                                                                                                                                                                                                                                                                                                              Returns this

                                                                                                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                                                                                                              • event: "end"
                                                                                                                                                                                                                                                                                                                              • listener: () => void

                                                                                                                                                                                                                                                                                                                              Returns this

                                                                                                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                                                                                                              • event: "error"
                                                                                                                                                                                                                                                                                                                              • listener: (err: Error) => void

                                                                                                                                                                                                                                                                                                                              Returns this

                                                                                                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                                                                                                              • event: "pause"
                                                                                                                                                                                                                                                                                                                              • listener: () => void

                                                                                                                                                                                                                                                                                                                              Returns this

                                                                                                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                                                                                                              • event: "readable"
                                                                                                                                                                                                                                                                                                                              • listener: () => void

                                                                                                                                                                                                                                                                                                                              Returns this

                                                                                                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                                                                                                              • event: "resume"
                                                                                                                                                                                                                                                                                                                              • listener: () => void

                                                                                                                                                                                                                                                                                                                              Returns this

                                                                                                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                                                                                                              • event: string | symbol
                                                                                                                                                                                                                                                                                                                              • listener: (...args: any[]) => void

                                                                                                                                                                                                                                                                                                                              Returns this

                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                            diff --git a/docs/functions/_internal_.prependOnceListener-3.html b/docs/functions/_internal_.prependOnceListener-3.html deleted file mode 100644 index e2a54add..00000000 --- a/docs/functions/_internal_.prependOnceListener-3.html +++ /dev/null @@ -1,9 +0,0 @@ -prependOnceListener | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                              Function prependOnceListener

                                                                                                                                                                                                                                                                                                                              • Adds a one-timelistener function for the event named eventName to the beginning of the listeners array. The next time eventName is triggered, this -listener is removed, and then invoked.

                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                server.prependOnceListener('connection', (stream) => {
                                                                                                                                                                                                                                                                                                                                  console.log('Ah, we have our first user!');
                                                                                                                                                                                                                                                                                                                                });
-
                                                                                                                                                                                                                                                                                                                                - -

                                                                                                                                                                                                                                                                                                                                Returns a reference to the EventEmitter, so that calls can be chained.

                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                • event: "close"
                                                                                                                                                                                                                                                                                                                                • listener: () => void

                                                                                                                                                                                                                                                                                                                                  The callback function

                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                Returns this

                                                                                                                                                                                                                                                                                                                                v6.0.0

                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                              • Parameters

                                                                                                                                                                                                                                                                                                                                • event: "drain"
                                                                                                                                                                                                                                                                                                                                • listener: () => void

                                                                                                                                                                                                                                                                                                                                Returns this

                                                                                                                                                                                                                                                                                                                              • Parameters

                                                                                                                                                                                                                                                                                                                                • event: "error"
                                                                                                                                                                                                                                                                                                                                • listener: (err: Error) => void

                                                                                                                                                                                                                                                                                                                                Returns this

                                                                                                                                                                                                                                                                                                                              • Parameters

                                                                                                                                                                                                                                                                                                                                • event: "finish"
                                                                                                                                                                                                                                                                                                                                • listener: () => void

                                                                                                                                                                                                                                                                                                                                Returns this

                                                                                                                                                                                                                                                                                                                              • Parameters

                                                                                                                                                                                                                                                                                                                                • event: "pipe"
                                                                                                                                                                                                                                                                                                                                • listener: (src: Readable) => void

                                                                                                                                                                                                                                                                                                                                Returns this

                                                                                                                                                                                                                                                                                                                              • Parameters

                                                                                                                                                                                                                                                                                                                                • event: "unpipe"
                                                                                                                                                                                                                                                                                                                                • listener: (src: Readable) => void

                                                                                                                                                                                                                                                                                                                                Returns this

                                                                                                                                                                                                                                                                                                                              • Parameters

                                                                                                                                                                                                                                                                                                                                • event: string | symbol
                                                                                                                                                                                                                                                                                                                                • listener: (...args: any[]) => void

                                                                                                                                                                                                                                                                                                                                Returns this

                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                              diff --git a/docs/functions/_internal_.prependOnceListener.html b/docs/functions/_internal_.prependOnceListener.html deleted file mode 100644 index 71ca672a..00000000 --- a/docs/functions/_internal_.prependOnceListener.html +++ /dev/null @@ -1,10 +0,0 @@ -prependOnceListener | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                Function prependOnceListener

                                                                                                                                                                                                                                                                                                                                • Adds a one-timelistener function for the event named eventName to the beginning of the listeners array. The next time eventName is triggered, this -listener is removed, and then invoked.

                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                  server.prependOnceListener('connection', (stream) => {
                                                                                                                                                                                                                                                                                                                                    console.log('Ah, we have our first user!');
                                                                                                                                                                                                                                                                                                                                  });
-
                                                                                                                                                                                                                                                                                                                                  - -

                                                                                                                                                                                                                                                                                                                                  Returns a reference to the EventEmitter, so that calls can be chained.

                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                  Type Parameters

                                                                                                                                                                                                                                                                                                                                  • K

                                                                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                                                                  • eventName: Key<K, T>

                                                                                                                                                                                                                                                                                                                                    The name of the event.

                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                  • listener: Listener<K, T>

                                                                                                                                                                                                                                                                                                                                    The callback function

                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                  Returns this

                                                                                                                                                                                                                                                                                                                                  v6.0.0

                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                diff --git a/docs/functions/_internal_.rawListeners.html b/docs/functions/_internal_.rawListeners.html deleted file mode 100644 index a1888280..00000000 --- a/docs/functions/_internal_.rawListeners.html +++ /dev/null @@ -1,7 +0,0 @@ -rawListeners | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                  Function rawListeners

                                                                                                                                                                                                                                                                                                                                  • Returns a copy of the array of listeners for the event named eventName, -including any wrappers (such as those created by .once()).

                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                    import { EventEmitter } from 'node:events';
                                                                                                                                                                                                                                                                                                                                    const emitter = new EventEmitter();
                                                                                                                                                                                                                                                                                                                                    emitter.once('log', () => console.log('log once'));

                                                                                                                                                                                                                                                                                                                                    // Returns a new Array with a function `onceWrapper` which has a property
                                                                                                                                                                                                                                                                                                                                    // `listener` which contains the original listener bound above
                                                                                                                                                                                                                                                                                                                                    const listeners = emitter.rawListeners('log');
                                                                                                                                                                                                                                                                                                                                    const logFnWrapper = listeners[0];

                                                                                                                                                                                                                                                                                                                                    // Logs "log once" to the console and does not unbind the `once` event
                                                                                                                                                                                                                                                                                                                                    logFnWrapper.listener();

                                                                                                                                                                                                                                                                                                                                    // Logs "log once" to the console and removes the listener
                                                                                                                                                                                                                                                                                                                                    logFnWrapper();

                                                                                                                                                                                                                                                                                                                                    emitter.on('log', () => console.log('log persistently'));
                                                                                                                                                                                                                                                                                                                                    // Will return a new Array with a single function bound by `.on()` above
                                                                                                                                                                                                                                                                                                                                    const newListeners = emitter.rawListeners('log');

                                                                                                                                                                                                                                                                                                                                    // Logs "log persistently" twice
                                                                                                                                                                                                                                                                                                                                    newListeners[0]();
                                                                                                                                                                                                                                                                                                                                    emitter.emit('log');
-
                                                                                                                                                                                                                                                                                                                                    - -

                                                                                                                                                                                                                                                                                                                                    Type Parameters

                                                                                                                                                                                                                                                                                                                                    • K

                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                    Returns Listener<K, T, Function>[]

                                                                                                                                                                                                                                                                                                                                    v9.4.0

                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/functions/_internal_.read-1.html b/docs/functions/_internal_.read-1.html deleted file mode 100644 index 37cd6831..00000000 --- a/docs/functions/_internal_.read-1.html +++ /dev/null @@ -1 +0,0 @@ -read | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                    Function readOptional

                                                                                                                                                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                                                                                                                                                      • this: T
                                                                                                                                                                                                                                                                                                                                      • size: number

                                                                                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/functions/_internal_.read.html b/docs/functions/_internal_.read.html deleted file mode 100644 index 16abc4a6..00000000 --- a/docs/functions/_internal_.read.html +++ /dev/null @@ -1 +0,0 @@ -read | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                      Function read

                                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                                        • Optionalsize: number

                                                                                                                                                                                                                                                                                                                                        Returns string | Buffer<ArrayBufferLike>

                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/functions/_internal_.reduce.html b/docs/functions/_internal_.reduce.html deleted file mode 100644 index bbff5598..00000000 --- a/docs/functions/_internal_.reduce.html +++ /dev/null @@ -1,21 +0,0 @@ -reduce | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                        Function reduce

                                                                                                                                                                                                                                                                                                                                        • This method calls fn on each chunk of the stream in order, passing it the result from the calculation -on the previous element. It returns a promise for the final value of the reduction.

                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                          If no initial value is supplied the first chunk of the stream is used as the initial value. -If the stream is empty, the promise is rejected with a TypeError with the ERR_INVALID_ARGS code property.

                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                          The reducer function iterates the stream element-by-element which means that there is no concurrency parameter -or parallelism. To perform a reduce concurrently, you can extract the async function to readable.map method.

                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                          Type Parameters

                                                                                                                                                                                                                                                                                                                                          • T = any

                                                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                                                          • fn: (previous: any, data: any, options?: Pick<Stream.ArrayOptions, "signal">) => T

                                                                                                                                                                                                                                                                                                                                            a reducer function to call over every chunk in the stream. Async or not.

                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                          • Optionalinitial: undefined

                                                                                                                                                                                                                                                                                                                                            the initial value to use in the reduction.

                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                          • Optionaloptions: Pick<Stream.ArrayOptions, "signal">

                                                                                                                                                                                                                                                                                                                                          Returns Promise<T>

                                                                                                                                                                                                                                                                                                                                          a promise for the final value of the reduction.

                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                          v17.5.0

                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                        • This method calls fn on each chunk of the stream in order, passing it the result from the calculation -on the previous element. It returns a promise for the final value of the reduction.

                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                          If no initial value is supplied the first chunk of the stream is used as the initial value. -If the stream is empty, the promise is rejected with a TypeError with the ERR_INVALID_ARGS code property.

                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                          The reducer function iterates the stream element-by-element which means that there is no concurrency parameter -or parallelism. To perform a reduce concurrently, you can extract the async function to readable.map method.

                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                          Type Parameters

                                                                                                                                                                                                                                                                                                                                          • T = any

                                                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                                                          • fn: (previous: T, data: any, options?: Pick<Stream.ArrayOptions, "signal">) => T

                                                                                                                                                                                                                                                                                                                                            a reducer function to call over every chunk in the stream. Async or not.

                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                          • initial: T

                                                                                                                                                                                                                                                                                                                                            the initial value to use in the reduction.

                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                          • Optionaloptions: Pick<Stream.ArrayOptions, "signal">

                                                                                                                                                                                                                                                                                                                                          Returns Promise<T>

                                                                                                                                                                                                                                                                                                                                          a promise for the final value of the reduction.

                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                          v17.5.0

                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/functions/_internal_.removeAllListeners.html b/docs/functions/_internal_.removeAllListeners.html deleted file mode 100644 index 88a0eb34..00000000 --- a/docs/functions/_internal_.removeAllListeners.html +++ /dev/null @@ -1,7 +0,0 @@ -removeAllListeners | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                          Function removeAllListeners

                                                                                                                                                                                                                                                                                                                                          • Removes all listeners, or those of the specified eventName.

                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                            It is bad practice to remove listeners added elsewhere in the code, -particularly when the EventEmitter instance was created by some other -component or module (e.g. sockets or file streams).

                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                            Returns a reference to the EventEmitter, so that calls can be chained.

                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                            • OptionaleventName: Key<unknown, T>

                                                                                                                                                                                                                                                                                                                                            Returns this

                                                                                                                                                                                                                                                                                                                                            v0.1.26

                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/functions/_internal_.removeHeader.html b/docs/functions/_internal_.removeHeader.html deleted file mode 100644 index a81f2e97..00000000 --- a/docs/functions/_internal_.removeHeader.html +++ /dev/null @@ -1,7 +0,0 @@ -removeHeader | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                            Function removeHeader

                                                                                                                                                                                                                                                                                                                                            • Removes a header that is queued for implicit sending.

                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                              outgoingMessage.removeHeader('Content-Encoding');
-
                                                                                                                                                                                                                                                                                                                                              - -

                                                                                                                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                                                                                                                              • name: string

                                                                                                                                                                                                                                                                                                                                                Header name

                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                              Returns void

                                                                                                                                                                                                                                                                                                                                              v0.4.0

                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/functions/_internal_.removeListener-1.html b/docs/functions/_internal_.removeListener-1.html deleted file mode 100644 index 9081bb7f..00000000 --- a/docs/functions/_internal_.removeListener-1.html +++ /dev/null @@ -1,28 +0,0 @@ -removeListener | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                              Function removeListener

                                                                                                                                                                                                                                                                                                                                              • Removes the specified listener from the listener array for the event named eventName.

                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                const callback = (stream) => {
                                                                                                                                                                                                                                                                                                                                                  console.log('someone connected!');
                                                                                                                                                                                                                                                                                                                                                };
                                                                                                                                                                                                                                                                                                                                                server.on('connection', callback);
                                                                                                                                                                                                                                                                                                                                                // ...
                                                                                                                                                                                                                                                                                                                                                server.removeListener('connection', callback);
-
                                                                                                                                                                                                                                                                                                                                                - -

                                                                                                                                                                                                                                                                                                                                                removeListener() will remove, at most, one instance of a listener from the -listener array. If any single listener has been added multiple times to the -listener array for the specified eventName, then removeListener() must be -called multiple times to remove each instance.

                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                Once an event is emitted, all listeners attached to it at the -time of emitting are called in order. This implies that any removeListener() or removeAllListeners() calls after emitting and before the last listener finishes execution -will not remove them fromemit() in progress. Subsequent events behave as expected.

                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                import { EventEmitter } from 'node:events';
                                                                                                                                                                                                                                                                                                                                                class MyEmitter extends EventEmitter {}
                                                                                                                                                                                                                                                                                                                                                const myEmitter = new MyEmitter();

                                                                                                                                                                                                                                                                                                                                                const callbackA = () => {
                                                                                                                                                                                                                                                                                                                                                  console.log('A');
                                                                                                                                                                                                                                                                                                                                                  myEmitter.removeListener('event', callbackB);
                                                                                                                                                                                                                                                                                                                                                };

                                                                                                                                                                                                                                                                                                                                                const callbackB = () => {
                                                                                                                                                                                                                                                                                                                                                  console.log('B');
                                                                                                                                                                                                                                                                                                                                                };

                                                                                                                                                                                                                                                                                                                                                myEmitter.on('event', callbackA);

                                                                                                                                                                                                                                                                                                                                                myEmitter.on('event', callbackB);

                                                                                                                                                                                                                                                                                                                                                // callbackA removes listener callbackB but it will still be called.
                                                                                                                                                                                                                                                                                                                                                // Internal listener array at time of emit [callbackA, callbackB]
                                                                                                                                                                                                                                                                                                                                                myEmitter.emit('event');
                                                                                                                                                                                                                                                                                                                                                // Prints:
                                                                                                                                                                                                                                                                                                                                                //   A
                                                                                                                                                                                                                                                                                                                                                //   B

                                                                                                                                                                                                                                                                                                                                                // callbackB is now removed.
                                                                                                                                                                                                                                                                                                                                                // Internal listener array [callbackA]
                                                                                                                                                                                                                                                                                                                                                myEmitter.emit('event');
                                                                                                                                                                                                                                                                                                                                                // Prints:
                                                                                                                                                                                                                                                                                                                                                //   A
-
                                                                                                                                                                                                                                                                                                                                                - -

                                                                                                                                                                                                                                                                                                                                                Because listeners are managed using an internal array, calling this will -change the position indices of any listener registered after the listener -being removed. This will not impact the order in which listeners are called, -but it means that any copies of the listener array as returned by -the emitter.listeners() method will need to be recreated.

                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                When a single function has been added as a handler multiple times for a single -event (as in the example below), removeListener() will remove the most -recently added instance. In the example the once('ping') listener is removed:

                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                import { EventEmitter } from 'node:events';
                                                                                                                                                                                                                                                                                                                                                const ee = new EventEmitter();

                                                                                                                                                                                                                                                                                                                                                function pong() {
                                                                                                                                                                                                                                                                                                                                                  console.log('pong');
                                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                                ee.on('ping', pong);
                                                                                                                                                                                                                                                                                                                                                ee.once('ping', pong);
                                                                                                                                                                                                                                                                                                                                                ee.removeListener('ping', pong);

                                                                                                                                                                                                                                                                                                                                                ee.emit('ping');
                                                                                                                                                                                                                                                                                                                                                ee.emit('ping');
-
                                                                                                                                                                                                                                                                                                                                                - -

                                                                                                                                                                                                                                                                                                                                                Returns a reference to the EventEmitter, so that calls can be chained.

                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                                • event: "close"
                                                                                                                                                                                                                                                                                                                                                • listener: () => void

                                                                                                                                                                                                                                                                                                                                                Returns this

                                                                                                                                                                                                                                                                                                                                                v0.1.26

                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                              • Parameters

                                                                                                                                                                                                                                                                                                                                                • event: "data"
                                                                                                                                                                                                                                                                                                                                                • listener: (chunk: any) => void

                                                                                                                                                                                                                                                                                                                                                Returns this

                                                                                                                                                                                                                                                                                                                                              • Parameters

                                                                                                                                                                                                                                                                                                                                                • event: "drain"
                                                                                                                                                                                                                                                                                                                                                • listener: () => void

                                                                                                                                                                                                                                                                                                                                                Returns this

                                                                                                                                                                                                                                                                                                                                              • Parameters

                                                                                                                                                                                                                                                                                                                                                • event: "end"
                                                                                                                                                                                                                                                                                                                                                • listener: () => void

                                                                                                                                                                                                                                                                                                                                                Returns this

                                                                                                                                                                                                                                                                                                                                              • Parameters

                                                                                                                                                                                                                                                                                                                                                • event: "error"
                                                                                                                                                                                                                                                                                                                                                • listener: (err: Error) => void

                                                                                                                                                                                                                                                                                                                                                Returns this

                                                                                                                                                                                                                                                                                                                                              • Parameters

                                                                                                                                                                                                                                                                                                                                                • event: "finish"
                                                                                                                                                                                                                                                                                                                                                • listener: () => void

                                                                                                                                                                                                                                                                                                                                                Returns this

                                                                                                                                                                                                                                                                                                                                              • Parameters

                                                                                                                                                                                                                                                                                                                                                • event: "pause"
                                                                                                                                                                                                                                                                                                                                                • listener: () => void

                                                                                                                                                                                                                                                                                                                                                Returns this

                                                                                                                                                                                                                                                                                                                                              • Parameters

                                                                                                                                                                                                                                                                                                                                                • event: "pipe"
                                                                                                                                                                                                                                                                                                                                                • listener: (src: Readable) => void

                                                                                                                                                                                                                                                                                                                                                Returns this

                                                                                                                                                                                                                                                                                                                                              • Parameters

                                                                                                                                                                                                                                                                                                                                                • event: "readable"
                                                                                                                                                                                                                                                                                                                                                • listener: () => void

                                                                                                                                                                                                                                                                                                                                                Returns this

                                                                                                                                                                                                                                                                                                                                              • Parameters

                                                                                                                                                                                                                                                                                                                                                • event: "resume"
                                                                                                                                                                                                                                                                                                                                                • listener: () => void

                                                                                                                                                                                                                                                                                                                                                Returns this

                                                                                                                                                                                                                                                                                                                                              • Parameters

                                                                                                                                                                                                                                                                                                                                                • event: "unpipe"
                                                                                                                                                                                                                                                                                                                                                • listener: (src: Readable) => void

                                                                                                                                                                                                                                                                                                                                                Returns this

                                                                                                                                                                                                                                                                                                                                              • Parameters

                                                                                                                                                                                                                                                                                                                                                • event: string | symbol
                                                                                                                                                                                                                                                                                                                                                • listener: (...args: any[]) => void

                                                                                                                                                                                                                                                                                                                                                Returns this

                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/functions/_internal_.removeListener-2.html b/docs/functions/_internal_.removeListener-2.html deleted file mode 100644 index c8ec734d..00000000 --- a/docs/functions/_internal_.removeListener-2.html +++ /dev/null @@ -1,28 +0,0 @@ -removeListener | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                Function removeListener

                                                                                                                                                                                                                                                                                                                                                • Removes the specified listener from the listener array for the event named eventName.

                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                  const callback = (stream) => {
                                                                                                                                                                                                                                                                                                                                                    console.log('someone connected!');
                                                                                                                                                                                                                                                                                                                                                  };
                                                                                                                                                                                                                                                                                                                                                  server.on('connection', callback);
                                                                                                                                                                                                                                                                                                                                                  // ...
                                                                                                                                                                                                                                                                                                                                                  server.removeListener('connection', callback);
-
                                                                                                                                                                                                                                                                                                                                                  - -

                                                                                                                                                                                                                                                                                                                                                  removeListener() will remove, at most, one instance of a listener from the -listener array. If any single listener has been added multiple times to the -listener array for the specified eventName, then removeListener() must be -called multiple times to remove each instance.

                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                  Once an event is emitted, all listeners attached to it at the -time of emitting are called in order. This implies that any removeListener() or removeAllListeners() calls after emitting and before the last listener finishes execution -will not remove them fromemit() in progress. Subsequent events behave as expected.

                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                  import { EventEmitter } from 'node:events';
                                                                                                                                                                                                                                                                                                                                                  class MyEmitter extends EventEmitter {}
                                                                                                                                                                                                                                                                                                                                                  const myEmitter = new MyEmitter();

                                                                                                                                                                                                                                                                                                                                                  const callbackA = () => {
                                                                                                                                                                                                                                                                                                                                                    console.log('A');
                                                                                                                                                                                                                                                                                                                                                    myEmitter.removeListener('event', callbackB);
                                                                                                                                                                                                                                                                                                                                                  };

                                                                                                                                                                                                                                                                                                                                                  const callbackB = () => {
                                                                                                                                                                                                                                                                                                                                                    console.log('B');
                                                                                                                                                                                                                                                                                                                                                  };

                                                                                                                                                                                                                                                                                                                                                  myEmitter.on('event', callbackA);

                                                                                                                                                                                                                                                                                                                                                  myEmitter.on('event', callbackB);

                                                                                                                                                                                                                                                                                                                                                  // callbackA removes listener callbackB but it will still be called.
                                                                                                                                                                                                                                                                                                                                                  // Internal listener array at time of emit [callbackA, callbackB]
                                                                                                                                                                                                                                                                                                                                                  myEmitter.emit('event');
                                                                                                                                                                                                                                                                                                                                                  // Prints:
                                                                                                                                                                                                                                                                                                                                                  //   A
                                                                                                                                                                                                                                                                                                                                                  //   B

                                                                                                                                                                                                                                                                                                                                                  // callbackB is now removed.
                                                                                                                                                                                                                                                                                                                                                  // Internal listener array [callbackA]
                                                                                                                                                                                                                                                                                                                                                  myEmitter.emit('event');
                                                                                                                                                                                                                                                                                                                                                  // Prints:
                                                                                                                                                                                                                                                                                                                                                  //   A
-
                                                                                                                                                                                                                                                                                                                                                  - -

                                                                                                                                                                                                                                                                                                                                                  Because listeners are managed using an internal array, calling this will -change the position indices of any listener registered after the listener -being removed. This will not impact the order in which listeners are called, -but it means that any copies of the listener array as returned by -the emitter.listeners() method will need to be recreated.

                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                  When a single function has been added as a handler multiple times for a single -event (as in the example below), removeListener() will remove the most -recently added instance. In the example the once('ping') listener is removed:

                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                  import { EventEmitter } from 'node:events';
                                                                                                                                                                                                                                                                                                                                                  const ee = new EventEmitter();

                                                                                                                                                                                                                                                                                                                                                  function pong() {
                                                                                                                                                                                                                                                                                                                                                    console.log('pong');
                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                  ee.on('ping', pong);
                                                                                                                                                                                                                                                                                                                                                  ee.once('ping', pong);
                                                                                                                                                                                                                                                                                                                                                  ee.removeListener('ping', pong);

                                                                                                                                                                                                                                                                                                                                                  ee.emit('ping');
                                                                                                                                                                                                                                                                                                                                                  ee.emit('ping');
-
                                                                                                                                                                                                                                                                                                                                                  - -

                                                                                                                                                                                                                                                                                                                                                  Returns a reference to the EventEmitter, so that calls can be chained.

                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                                                                                  • event: "close"
                                                                                                                                                                                                                                                                                                                                                  • listener: () => void

                                                                                                                                                                                                                                                                                                                                                  Returns this

                                                                                                                                                                                                                                                                                                                                                  v0.1.26

                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                                                                                                  • event: "data"
                                                                                                                                                                                                                                                                                                                                                  • listener: (chunk: any) => void

                                                                                                                                                                                                                                                                                                                                                  Returns this

                                                                                                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                                                                                                  • event: "end"
                                                                                                                                                                                                                                                                                                                                                  • listener: () => void

                                                                                                                                                                                                                                                                                                                                                  Returns this

                                                                                                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                                                                                                  • event: "error"
                                                                                                                                                                                                                                                                                                                                                  • listener: (err: Error) => void

                                                                                                                                                                                                                                                                                                                                                  Returns this

                                                                                                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                                                                                                  • event: "pause"
                                                                                                                                                                                                                                                                                                                                                  • listener: () => void

                                                                                                                                                                                                                                                                                                                                                  Returns this

                                                                                                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                                                                                                  • event: "readable"
                                                                                                                                                                                                                                                                                                                                                  • listener: () => void

                                                                                                                                                                                                                                                                                                                                                  Returns this

                                                                                                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                                                                                                  • event: "resume"
                                                                                                                                                                                                                                                                                                                                                  • listener: () => void

                                                                                                                                                                                                                                                                                                                                                  Returns this

                                                                                                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                                                                                                  • event: string | symbol
                                                                                                                                                                                                                                                                                                                                                  • listener: (...args: any[]) => void

                                                                                                                                                                                                                                                                                                                                                  Returns this

                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/functions/_internal_.removeListener-3.html b/docs/functions/_internal_.removeListener-3.html deleted file mode 100644 index ed63ee4d..00000000 --- a/docs/functions/_internal_.removeListener-3.html +++ /dev/null @@ -1,28 +0,0 @@ -removeListener | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                  Function removeListener

                                                                                                                                                                                                                                                                                                                                                  • Removes the specified listener from the listener array for the event named eventName.

                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                    const callback = (stream) => {
                                                                                                                                                                                                                                                                                                                                                      console.log('someone connected!');
                                                                                                                                                                                                                                                                                                                                                    };
                                                                                                                                                                                                                                                                                                                                                    server.on('connection', callback);
                                                                                                                                                                                                                                                                                                                                                    // ...
                                                                                                                                                                                                                                                                                                                                                    server.removeListener('connection', callback);
-
                                                                                                                                                                                                                                                                                                                                                    - -

                                                                                                                                                                                                                                                                                                                                                    removeListener() will remove, at most, one instance of a listener from the -listener array. If any single listener has been added multiple times to the -listener array for the specified eventName, then removeListener() must be -called multiple times to remove each instance.

                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Once an event is emitted, all listeners attached to it at the -time of emitting are called in order. This implies that any removeListener() or removeAllListeners() calls after emitting and before the last listener finishes execution -will not remove them fromemit() in progress. Subsequent events behave as expected.

                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                    import { EventEmitter } from 'node:events';
                                                                                                                                                                                                                                                                                                                                                    class MyEmitter extends EventEmitter {}
                                                                                                                                                                                                                                                                                                                                                    const myEmitter = new MyEmitter();

                                                                                                                                                                                                                                                                                                                                                    const callbackA = () => {
                                                                                                                                                                                                                                                                                                                                                      console.log('A');
                                                                                                                                                                                                                                                                                                                                                      myEmitter.removeListener('event', callbackB);
                                                                                                                                                                                                                                                                                                                                                    };

                                                                                                                                                                                                                                                                                                                                                    const callbackB = () => {
                                                                                                                                                                                                                                                                                                                                                      console.log('B');
                                                                                                                                                                                                                                                                                                                                                    };

                                                                                                                                                                                                                                                                                                                                                    myEmitter.on('event', callbackA);

                                                                                                                                                                                                                                                                                                                                                    myEmitter.on('event', callbackB);

                                                                                                                                                                                                                                                                                                                                                    // callbackA removes listener callbackB but it will still be called.
                                                                                                                                                                                                                                                                                                                                                    // Internal listener array at time of emit [callbackA, callbackB]
                                                                                                                                                                                                                                                                                                                                                    myEmitter.emit('event');
                                                                                                                                                                                                                                                                                                                                                    // Prints:
                                                                                                                                                                                                                                                                                                                                                    //   A
                                                                                                                                                                                                                                                                                                                                                    //   B

                                                                                                                                                                                                                                                                                                                                                    // callbackB is now removed.
                                                                                                                                                                                                                                                                                                                                                    // Internal listener array [callbackA]
                                                                                                                                                                                                                                                                                                                                                    myEmitter.emit('event');
                                                                                                                                                                                                                                                                                                                                                    // Prints:
                                                                                                                                                                                                                                                                                                                                                    //   A
-
                                                                                                                                                                                                                                                                                                                                                    - -

                                                                                                                                                                                                                                                                                                                                                    Because listeners are managed using an internal array, calling this will -change the position indices of any listener registered after the listener -being removed. This will not impact the order in which listeners are called, -but it means that any copies of the listener array as returned by -the emitter.listeners() method will need to be recreated.

                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    When a single function has been added as a handler multiple times for a single -event (as in the example below), removeListener() will remove the most -recently added instance. In the example the once('ping') listener is removed:

                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                    import { EventEmitter } from 'node:events';
                                                                                                                                                                                                                                                                                                                                                    const ee = new EventEmitter();

                                                                                                                                                                                                                                                                                                                                                    function pong() {
                                                                                                                                                                                                                                                                                                                                                      console.log('pong');
                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                    ee.on('ping', pong);
                                                                                                                                                                                                                                                                                                                                                    ee.once('ping', pong);
                                                                                                                                                                                                                                                                                                                                                    ee.removeListener('ping', pong);

                                                                                                                                                                                                                                                                                                                                                    ee.emit('ping');
                                                                                                                                                                                                                                                                                                                                                    ee.emit('ping');
-
                                                                                                                                                                                                                                                                                                                                                    - -

                                                                                                                                                                                                                                                                                                                                                    Returns a reference to the EventEmitter, so that calls can be chained.

                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                    • event: "close"
                                                                                                                                                                                                                                                                                                                                                    • listener: () => void

                                                                                                                                                                                                                                                                                                                                                    Returns this

                                                                                                                                                                                                                                                                                                                                                    v0.1.26

                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                                                                    • event: "drain"
                                                                                                                                                                                                                                                                                                                                                    • listener: () => void

                                                                                                                                                                                                                                                                                                                                                    Returns this

                                                                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                                                                    • event: "error"
                                                                                                                                                                                                                                                                                                                                                    • listener: (err: Error) => void

                                                                                                                                                                                                                                                                                                                                                    Returns this

                                                                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                                                                    • event: "finish"
                                                                                                                                                                                                                                                                                                                                                    • listener: () => void

                                                                                                                                                                                                                                                                                                                                                    Returns this

                                                                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                                                                    • event: "pipe"
                                                                                                                                                                                                                                                                                                                                                    • listener: (src: Readable) => void

                                                                                                                                                                                                                                                                                                                                                    Returns this

                                                                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                                                                    • event: "unpipe"
                                                                                                                                                                                                                                                                                                                                                    • listener: (src: Readable) => void

                                                                                                                                                                                                                                                                                                                                                    Returns this

                                                                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                                                                    • event: string | symbol
                                                                                                                                                                                                                                                                                                                                                    • listener: (...args: any[]) => void

                                                                                                                                                                                                                                                                                                                                                    Returns this

                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/functions/_internal_.removeListener.html b/docs/functions/_internal_.removeListener.html deleted file mode 100644 index 5bc7663c..00000000 --- a/docs/functions/_internal_.removeListener.html +++ /dev/null @@ -1,28 +0,0 @@ -removeListener | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                    Function removeListener

                                                                                                                                                                                                                                                                                                                                                    • Removes the specified listener from the listener array for the event named eventName.

                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                      const callback = (stream) => {
                                                                                                                                                                                                                                                                                                                                                        console.log('someone connected!');
                                                                                                                                                                                                                                                                                                                                                      };
                                                                                                                                                                                                                                                                                                                                                      server.on('connection', callback);
                                                                                                                                                                                                                                                                                                                                                      // ...
                                                                                                                                                                                                                                                                                                                                                      server.removeListener('connection', callback);
-
                                                                                                                                                                                                                                                                                                                                                      - -

                                                                                                                                                                                                                                                                                                                                                      removeListener() will remove, at most, one instance of a listener from the -listener array. If any single listener has been added multiple times to the -listener array for the specified eventName, then removeListener() must be -called multiple times to remove each instance.

                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                      Once an event is emitted, all listeners attached to it at the -time of emitting are called in order. This implies that any removeListener() or removeAllListeners() calls after emitting and before the last listener finishes execution -will not remove them fromemit() in progress. Subsequent events behave as expected.

                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                      import { EventEmitter } from 'node:events';
                                                                                                                                                                                                                                                                                                                                                      class MyEmitter extends EventEmitter {}
                                                                                                                                                                                                                                                                                                                                                      const myEmitter = new MyEmitter();

                                                                                                                                                                                                                                                                                                                                                      const callbackA = () => {
                                                                                                                                                                                                                                                                                                                                                        console.log('A');
                                                                                                                                                                                                                                                                                                                                                        myEmitter.removeListener('event', callbackB);
                                                                                                                                                                                                                                                                                                                                                      };

                                                                                                                                                                                                                                                                                                                                                      const callbackB = () => {
                                                                                                                                                                                                                                                                                                                                                        console.log('B');
                                                                                                                                                                                                                                                                                                                                                      };

                                                                                                                                                                                                                                                                                                                                                      myEmitter.on('event', callbackA);

                                                                                                                                                                                                                                                                                                                                                      myEmitter.on('event', callbackB);

                                                                                                                                                                                                                                                                                                                                                      // callbackA removes listener callbackB but it will still be called.
                                                                                                                                                                                                                                                                                                                                                      // Internal listener array at time of emit [callbackA, callbackB]
                                                                                                                                                                                                                                                                                                                                                      myEmitter.emit('event');
                                                                                                                                                                                                                                                                                                                                                      // Prints:
                                                                                                                                                                                                                                                                                                                                                      //   A
                                                                                                                                                                                                                                                                                                                                                      //   B

                                                                                                                                                                                                                                                                                                                                                      // callbackB is now removed.
                                                                                                                                                                                                                                                                                                                                                      // Internal listener array [callbackA]
                                                                                                                                                                                                                                                                                                                                                      myEmitter.emit('event');
                                                                                                                                                                                                                                                                                                                                                      // Prints:
                                                                                                                                                                                                                                                                                                                                                      //   A
-
                                                                                                                                                                                                                                                                                                                                                      - -

                                                                                                                                                                                                                                                                                                                                                      Because listeners are managed using an internal array, calling this will -change the position indices of any listener registered after the listener -being removed. This will not impact the order in which listeners are called, -but it means that any copies of the listener array as returned by -the emitter.listeners() method will need to be recreated.

                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                      When a single function has been added as a handler multiple times for a single -event (as in the example below), removeListener() will remove the most -recently added instance. In the example the once('ping') listener is removed:

                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                      import { EventEmitter } from 'node:events';
                                                                                                                                                                                                                                                                                                                                                      const ee = new EventEmitter();

                                                                                                                                                                                                                                                                                                                                                      function pong() {
                                                                                                                                                                                                                                                                                                                                                        console.log('pong');
                                                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                                                      ee.on('ping', pong);
                                                                                                                                                                                                                                                                                                                                                      ee.once('ping', pong);
                                                                                                                                                                                                                                                                                                                                                      ee.removeListener('ping', pong);

                                                                                                                                                                                                                                                                                                                                                      ee.emit('ping');
                                                                                                                                                                                                                                                                                                                                                      ee.emit('ping');
-
                                                                                                                                                                                                                                                                                                                                                      - -

                                                                                                                                                                                                                                                                                                                                                      Returns a reference to the EventEmitter, so that calls can be chained.

                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                      Type Parameters

                                                                                                                                                                                                                                                                                                                                                      • K

                                                                                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                                                                                      Returns this

                                                                                                                                                                                                                                                                                                                                                      v0.1.26

                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/functions/_internal_.resolve.html b/docs/functions/_internal_.resolve.html deleted file mode 100644 index 35a4bf2e..00000000 --- a/docs/functions/_internal_.resolve.html +++ /dev/null @@ -1,3 +0,0 @@ -resolve | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                      Function resolve

                                                                                                                                                                                                                                                                                                                                                      • Resolve the value of this alias within doc, finding the last -instance of the source anchor before this node.

                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                        Returns Scalar<unknown> | YAMLMap<unknown, unknown> | YAMLSeq<unknown>

                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/functions/_internal_.resume-1.html b/docs/functions/_internal_.resume-1.html deleted file mode 100644 index 089adb5d..00000000 --- a/docs/functions/_internal_.resume-1.html +++ /dev/null @@ -1,10 +0,0 @@ -resume | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                        Function resume

                                                                                                                                                                                                                                                                                                                                                        • The readable.resume() method causes an explicitly paused Readable stream to -resume emitting 'data' events, switching the stream into flowing mode.

                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                          The readable.resume() method can be used to fully consume the data from a -stream without actually processing any of that data:

                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                          getReadableStreamSomehow()
                                                                                                                                                                                                                                                                                                                                                            .resume()
                                                                                                                                                                                                                                                                                                                                                            .on('end', () => {
                                                                                                                                                                                                                                                                                                                                                              console.log('Reached the end, but did not read anything.');
                                                                                                                                                                                                                                                                                                                                                            });
-
                                                                                                                                                                                                                                                                                                                                                          - -

                                                                                                                                                                                                                                                                                                                                                          The readable.resume() method has no effect if there is a 'readable' event listener.

                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                          Returns this

                                                                                                                                                                                                                                                                                                                                                          v0.9.4

                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/functions/_internal_.resume.html b/docs/functions/_internal_.resume.html deleted file mode 100644 index 6a1a4d76..00000000 --- a/docs/functions/_internal_.resume.html +++ /dev/null @@ -1 +0,0 @@ -resume | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                          Function resume

                                                                                                                                                                                                                                                                                                                                                          • Returns this

                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/functions/_internal_.return-1.html b/docs/functions/_internal_.return-1.html deleted file mode 100644 index ffa0b3ef..00000000 --- a/docs/functions/_internal_.return-1.html +++ /dev/null @@ -1 +0,0 @@ -return | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                            Function returnOptional

                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/functions/_internal_.return.html b/docs/functions/_internal_.return.html deleted file mode 100644 index 1ae5eb4d..00000000 --- a/docs/functions/_internal_.return.html +++ /dev/null @@ -1 +0,0 @@ -return | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                              Function returnOptional

                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/functions/_internal_.runInAsyncScope.html b/docs/functions/_internal_.runInAsyncScope.html deleted file mode 100644 index b6d51769..00000000 --- a/docs/functions/_internal_.runInAsyncScope.html +++ /dev/null @@ -1,9 +0,0 @@ -runInAsyncScope | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                Function runInAsyncScope

                                                                                                                                                                                                                                                                                                                                                                • Call the provided function with the provided arguments in the execution context -of the async resource. This will establish the context, trigger the AsyncHooks -before callbacks, call the function, trigger the AsyncHooks after callbacks, and -then restore the original execution context.

                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                  Type Parameters

                                                                                                                                                                                                                                                                                                                                                                  • This
                                                                                                                                                                                                                                                                                                                                                                  • Result

                                                                                                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                                                                                                  • fn: (this: This, ...args: any[]) => Result

                                                                                                                                                                                                                                                                                                                                                                    The function to call in the execution context of this async resource.

                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                  • OptionalthisArg: This

                                                                                                                                                                                                                                                                                                                                                                    The receiver to be used for the function call.

                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                  • ...args: any[]

                                                                                                                                                                                                                                                                                                                                                                    Optional arguments to pass to the function.

                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                  Returns Result

                                                                                                                                                                                                                                                                                                                                                                  v9.6.0

                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/functions/_internal_.set-1.html b/docs/functions/_internal_.set-1.html deleted file mode 100644 index 7047b438..00000000 --- a/docs/functions/_internal_.set-1.html +++ /dev/null @@ -1,3 +0,0 @@ -set | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                  Function set

                                                                                                                                                                                                                                                                                                                                                                  • Sets a value in this collection. For !!set, value needs to be a -boolean to add/remove the item from the set.

                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                    • key: K
                                                                                                                                                                                                                                                                                                                                                                    • value: V

                                                                                                                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/functions/_internal_.set-2.html b/docs/functions/_internal_.set-2.html deleted file mode 100644 index a4a60ce2..00000000 --- a/docs/functions/_internal_.set-2.html +++ /dev/null @@ -1,5 +0,0 @@ -set | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                    Function set

                                                                                                                                                                                                                                                                                                                                                                    • Sets a value in this collection. For !!set, value needs to be a -boolean to add/remove the item from the set.

                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                      If key does not contain a representation of an integer, this will throw. -It may be wrapped in a Scalar.

                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                                                                                                      • key: unknown
                                                                                                                                                                                                                                                                                                                                                                      • value: T

                                                                                                                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/functions/_internal_.set.html b/docs/functions/_internal_.set.html deleted file mode 100644 index 795d4954..00000000 --- a/docs/functions/_internal_.set.html +++ /dev/null @@ -1,3 +0,0 @@ -set | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                      Function set

                                                                                                                                                                                                                                                                                                                                                                      • Sets a value in this document. For !!set, value needs to be a -boolean to add/remove the item from the set.

                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                        • key: any
                                                                                                                                                                                                                                                                                                                                                                        • value: unknown

                                                                                                                                                                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/functions/_internal_.setDefaultEncoding.html b/docs/functions/_internal_.setDefaultEncoding.html deleted file mode 100644 index 799a9848..00000000 --- a/docs/functions/_internal_.setDefaultEncoding.html +++ /dev/null @@ -1,4 +0,0 @@ -setDefaultEncoding | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                        Function setDefaultEncoding

                                                                                                                                                                                                                                                                                                                                                                        • The writable.setDefaultEncoding() method sets the default encoding for a Writable stream.

                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                                                                                          Returns this

                                                                                                                                                                                                                                                                                                                                                                          v0.11.15

                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/functions/_internal_.setEncoding-1.html b/docs/functions/_internal_.setEncoding-1.html deleted file mode 100644 index 3ba5e5c2..00000000 --- a/docs/functions/_internal_.setEncoding-1.html +++ /dev/null @@ -1,15 +0,0 @@ -setEncoding | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                          Function setEncoding

                                                                                                                                                                                                                                                                                                                                                                          • The readable.setEncoding() method sets the character encoding for -data read from the Readable stream.

                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                            By default, no encoding is assigned and stream data will be returned as Buffer objects. Setting an encoding causes the stream data -to be returned as strings of the specified encoding rather than as Buffer objects. For instance, calling readable.setEncoding('utf8') will cause the -output data to be interpreted as UTF-8 data, and passed as strings. Calling readable.setEncoding('hex') will cause the data to be encoded in hexadecimal -string format.

                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                            The Readable stream will properly handle multi-byte characters delivered -through the stream that would otherwise become improperly decoded if simply -pulled from the stream as Buffer objects.

                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                            const readable = getReadableStreamSomehow();
                                                                                                                                                                                                                                                                                                                                                                            readable.setEncoding('utf8');
                                                                                                                                                                                                                                                                                                                                                                            readable.on('data', (chunk) => {
                                                                                                                                                                                                                                                                                                                                                                              assert.equal(typeof chunk, 'string');
                                                                                                                                                                                                                                                                                                                                                                              console.log('Got %d characters of string data:', chunk.length);
                                                                                                                                                                                                                                                                                                                                                                            });
-
                                                                                                                                                                                                                                                                                                                                                                            - -

                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                            Returns this

                                                                                                                                                                                                                                                                                                                                                                            v0.9.4

                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/functions/_internal_.setEncoding.html b/docs/functions/_internal_.setEncoding.html deleted file mode 100644 index 44037dc7..00000000 --- a/docs/functions/_internal_.setEncoding.html +++ /dev/null @@ -1 +0,0 @@ -setEncoding | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                            Function setEncoding

                                                                                                                                                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                                                                                                                                                              Returns this

                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/functions/_internal_.setHeader.html b/docs/functions/_internal_.setHeader.html deleted file mode 100644 index 7cebece5..00000000 --- a/docs/functions/_internal_.setHeader.html +++ /dev/null @@ -1,7 +0,0 @@ -setHeader | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                              Function setHeader

                                                                                                                                                                                                                                                                                                                                                                              • Sets a single header value. If the header already exists in the to-be-sent -headers, its value will be replaced. Use an array of strings to send multiple -headers with the same name.

                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                                                                • name: string

                                                                                                                                                                                                                                                                                                                                                                                  Header name

                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                • value: string | number | readonly string[]

                                                                                                                                                                                                                                                                                                                                                                                  Header value

                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                Returns this

                                                                                                                                                                                                                                                                                                                                                                                v0.4.0

                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/functions/_internal_.setHeaders.html b/docs/functions/_internal_.setHeaders.html deleted file mode 100644 index d1542921..00000000 --- a/docs/functions/_internal_.setHeaders.html +++ /dev/null @@ -1,18 +0,0 @@ -setHeaders | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                Function setHeaders

                                                                                                                                                                                                                                                                                                                                                                                • Sets multiple header values for implicit headers. headers must be an instance of -Headers or Map, if a header already exists in the to-be-sent headers, its -value will be replaced.

                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                  const headers = new Headers({ foo: 'bar' });
                                                                                                                                                                                                                                                                                                                                                                                  outgoingMessage.setHeaders(headers);
-
                                                                                                                                                                                                                                                                                                                                                                                  - -

                                                                                                                                                                                                                                                                                                                                                                                  or

                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                  const headers = new Map([['foo', 'bar']]);
                                                                                                                                                                                                                                                                                                                                                                                  outgoingMessage.setHeaders(headers);
-
                                                                                                                                                                                                                                                                                                                                                                                  - -

                                                                                                                                                                                                                                                                                                                                                                                  When headers have been set with outgoingMessage.setHeaders(), they will be -merged with any headers passed to response.writeHead(), with the headers passed -to response.writeHead() given precedence.

                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                  // Returns content-type = text/plain
                                                                                                                                                                                                                                                                                                                                                                                  const server = http.createServer((req, res) => {
                                                                                                                                                                                                                                                                                                                                                                                    const headers = new Headers({ 'Content-Type': 'text/html' });
                                                                                                                                                                                                                                                                                                                                                                                    res.setHeaders(headers);
                                                                                                                                                                                                                                                                                                                                                                                    res.writeHead(200, { 'Content-Type': 'text/plain' });
                                                                                                                                                                                                                                                                                                                                                                                    res.end('ok');
                                                                                                                                                                                                                                                                                                                                                                                  });
-
                                                                                                                                                                                                                                                                                                                                                                                  - -

                                                                                                                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                                                                                                                  • headers: Headers | Map<string, string | number | readonly string[]>

                                                                                                                                                                                                                                                                                                                                                                                  Returns this

                                                                                                                                                                                                                                                                                                                                                                                  v19.6.0, v18.15.0

                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/functions/_internal_.setHttpHandler.html b/docs/functions/_internal_.setHttpHandler.html deleted file mode 100644 index 6b000d95..00000000 --- a/docs/functions/_internal_.setHttpHandler.html +++ /dev/null @@ -1 +0,0 @@ -setHttpHandler | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                  Function setHttpHandler

                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/functions/_internal_.setIn.html b/docs/functions/_internal_.setIn.html deleted file mode 100644 index 7bb43d21..00000000 --- a/docs/functions/_internal_.setIn.html +++ /dev/null @@ -1,3 +0,0 @@ -setIn | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                    Function setIn

                                                                                                                                                                                                                                                                                                                                                                                    • Sets a value in this document. For !!set, value needs to be a -boolean to add/remove the item from the set.

                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                                                                                                                      • path: Iterable<unknown, any, any>
                                                                                                                                                                                                                                                                                                                                                                                      • value: unknown

                                                                                                                                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/functions/_internal_.setMaxListeners.html b/docs/functions/_internal_.setMaxListeners.html deleted file mode 100644 index 19459bd6..00000000 --- a/docs/functions/_internal_.setMaxListeners.html +++ /dev/null @@ -1,7 +0,0 @@ -setMaxListeners | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                      Function setMaxListeners

                                                                                                                                                                                                                                                                                                                                                                                      • By default EventEmitters will print a warning if more than 10 listeners are -added for a particular event. This is a useful default that helps finding -memory leaks. The emitter.setMaxListeners() method allows the limit to be -modified for this specific EventEmitter instance. The value can be set to Infinity (or 0) to indicate an unlimited number of listeners.

                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                        Returns a reference to the EventEmitter, so that calls can be chained.

                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                        • n: number

                                                                                                                                                                                                                                                                                                                                                                                        Returns this

                                                                                                                                                                                                                                                                                                                                                                                        v0.3.5

                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/functions/_internal_.setSchema.html b/docs/functions/_internal_.setSchema.html deleted file mode 100644 index b4c16c3c..00000000 --- a/docs/functions/_internal_.setSchema.html +++ /dev/null @@ -1,5 +0,0 @@ -setSchema | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                        Function setSchema

                                                                                                                                                                                                                                                                                                                                                                                        • Change the YAML version and schema used by the document. -A null version disables support for directives, explicit tags, anchors, and aliases. -It also requires the schema option to be given as a Schema instance value.

                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                          Overrides all previously set schema options.

                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/functions/_internal_.setTimeout.html b/docs/functions/_internal_.setTimeout.html deleted file mode 100644 index 90a05efa..00000000 --- a/docs/functions/_internal_.setTimeout.html +++ /dev/null @@ -1,4 +0,0 @@ -setTimeout | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                          Function setTimeout

                                                                                                                                                                                                                                                                                                                                                                                          • Once a socket is associated with the message and is connected, socket.setTimeout() will be called with msecs as the first parameter.

                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                            • msecs: number
                                                                                                                                                                                                                                                                                                                                                                                            • Optionalcallback: () => void

                                                                                                                                                                                                                                                                                                                                                                                              Optional function to be called when a timeout occurs. Same as binding to the timeout event.

                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                            Returns this

                                                                                                                                                                                                                                                                                                                                                                                            v0.9.12

                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/functions/_internal_.some.html b/docs/functions/_internal_.some.html deleted file mode 100644 index 67b60a51..00000000 --- a/docs/functions/_internal_.some.html +++ /dev/null @@ -1,8 +0,0 @@ -some | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                            Function some

                                                                                                                                                                                                                                                                                                                                                                                            • This method is similar to Array.prototype.some and calls fn on each chunk in the stream -until the awaited return value is true (or any truthy value). Once an fn call on a chunk -awaited return value is truthy, the stream is destroyed and the promise is fulfilled with true. -If none of the fn calls on the chunks return a truthy value, the promise is fulfilled with false.

                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                                                                                                                                                                              • fn: (
                                                                                                                                                                                                                                                                                                                                                                                                    data: any,
                                                                                                                                                                                                                                                                                                                                                                                                    options?: Pick<Stream.ArrayOptions, "signal">,
                                                                                                                                                                                                                                                                                                                                                                                                ) => boolean | Promise<boolean>

                                                                                                                                                                                                                                                                                                                                                                                                a function to call on each chunk of the stream. Async or not.

                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                              • Optionaloptions: Stream.ArrayOptions

                                                                                                                                                                                                                                                                                                                                                                                              Returns Promise<boolean>

                                                                                                                                                                                                                                                                                                                                                                                              a promise evaluating to true if fn returned a truthy value for at least one of the chunks.

                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                              v17.5.0

                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/functions/_internal_.throw-1.html b/docs/functions/_internal_.throw-1.html deleted file mode 100644 index 26a07d24..00000000 --- a/docs/functions/_internal_.throw-1.html +++ /dev/null @@ -1 +0,0 @@ -throw | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                              Function throwOptional

                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/functions/_internal_.throw.html b/docs/functions/_internal_.throw.html deleted file mode 100644 index 4d7128ae..00000000 --- a/docs/functions/_internal_.throw.html +++ /dev/null @@ -1 +0,0 @@ -throw | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                Function throwOptional

                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/functions/_internal_.toJS.html b/docs/functions/_internal_.toJS.html deleted file mode 100644 index 663612fa..00000000 --- a/docs/functions/_internal_.toJS.html +++ /dev/null @@ -1,2 +0,0 @@ -toJS | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                  Function toJS

                                                                                                                                                                                                                                                                                                                                                                                                  • A plain JavaScript representation of the document contents.

                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                    • Optionalopt: ToJSOptions & { [ignored: string]: unknown }

                                                                                                                                                                                                                                                                                                                                                                                                    Returns any

                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/functions/_internal_.toJSON-1.html b/docs/functions/_internal_.toJSON-1.html deleted file mode 100644 index f15ec7e7..00000000 --- a/docs/functions/_internal_.toJSON-1.html +++ /dev/null @@ -1,2 +0,0 @@ -toJSON | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                    Function toJSON

                                                                                                                                                                                                                                                                                                                                                                                                    • A plain JS representation of this node

                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                                                                                                                                      Returns any

                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/functions/_internal_.toJSON-2.html b/docs/functions/_internal_.toJSON-2.html deleted file mode 100644 index c7e084e3..00000000 --- a/docs/functions/_internal_.toJSON-2.html +++ /dev/null @@ -1,4 +0,0 @@ -toJSON | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                      Function toJSON

                                                                                                                                                                                                                                                                                                                                                                                                      • Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                        • T extends MapLike = Map<unknown, unknown>

                                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                                        • Optional_: unknown
                                                                                                                                                                                                                                                                                                                                                                                                        • Optionalctx: ToJSContext

                                                                                                                                                                                                                                                                                                                                                                                                          Conversion context, originally set in Document#toJS()

                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                        • OptionalType: new () => T

                                                                                                                                                                                                                                                                                                                                                                                                          If set, forces the returned collection type

                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                        Returns any

                                                                                                                                                                                                                                                                                                                                                                                                        Instance of Type, Map, or Object

                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/functions/_internal_.toJSON-3.html b/docs/functions/_internal_.toJSON-3.html deleted file mode 100644 index 07381e49..00000000 --- a/docs/functions/_internal_.toJSON-3.html +++ /dev/null @@ -1,2 +0,0 @@ -toJSON | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                        Function toJSON

                                                                                                                                                                                                                                                                                                                                                                                                        • A plain JS representation of this node

                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                                                                                                                          Returns unknown[]

                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/functions/_internal_.toJSON.html b/docs/functions/_internal_.toJSON.html deleted file mode 100644 index e8c9de69..00000000 --- a/docs/functions/_internal_.toJSON.html +++ /dev/null @@ -1,4 +0,0 @@ -toJSON | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                          Function toJSON

                                                                                                                                                                                                                                                                                                                                                                                                          • A JSON representation of the document contents.

                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                            • OptionaljsonArg: string

                                                                                                                                                                                                                                                                                                                                                                                                              Used by JSON.stringify to indicate the array index or -property name.

                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                            • OptionalonAnchor: (value: unknown, count: number) => void

                                                                                                                                                                                                                                                                                                                                                                                                            Returns any

                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/functions/_internal_.toString-1.html b/docs/functions/_internal_.toString-1.html deleted file mode 100644 index 56d37eff..00000000 --- a/docs/functions/_internal_.toString-1.html +++ /dev/null @@ -1 +0,0 @@ -toString | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                            Function toString

                                                                                                                                                                                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                              • Optionalctx: StringifyContext
                                                                                                                                                                                                                                                                                                                                                                                                              • Optional_onComment: () => void
                                                                                                                                                                                                                                                                                                                                                                                                              • Optional_onChompKeep: () => void

                                                                                                                                                                                                                                                                                                                                                                                                              Returns string

                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/functions/_internal_.toString-2.html b/docs/functions/_internal_.toString-2.html deleted file mode 100644 index 46a31e85..00000000 --- a/docs/functions/_internal_.toString-2.html +++ /dev/null @@ -1 +0,0 @@ -toString | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                              Function toString

                                                                                                                                                                                                                                                                                                                                                                                                              • Returns string

                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/functions/_internal_.toString-3.html b/docs/functions/_internal_.toString-3.html deleted file mode 100644 index d86bc36e..00000000 --- a/docs/functions/_internal_.toString-3.html +++ /dev/null @@ -1 +0,0 @@ -toString | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                Function toString

                                                                                                                                                                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                  • Optionalctx: StringifyContext
                                                                                                                                                                                                                                                                                                                                                                                                                  • OptionalonComment: () => void
                                                                                                                                                                                                                                                                                                                                                                                                                  • OptionalonChompKeep: () => void

                                                                                                                                                                                                                                                                                                                                                                                                                  Returns string

                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/functions/_internal_.toString-4.html b/docs/functions/_internal_.toString-4.html deleted file mode 100644 index d2ece83a..00000000 --- a/docs/functions/_internal_.toString-4.html +++ /dev/null @@ -1 +0,0 @@ -toString | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                  Function toString

                                                                                                                                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                    • Optionalctx: StringifyContext
                                                                                                                                                                                                                                                                                                                                                                                                                    • OptionalonComment: () => void
                                                                                                                                                                                                                                                                                                                                                                                                                    • OptionalonChompKeep: () => void

                                                                                                                                                                                                                                                                                                                                                                                                                    Returns string

                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/functions/_internal_.toString-5.html b/docs/functions/_internal_.toString-5.html deleted file mode 100644 index ba5365f2..00000000 --- a/docs/functions/_internal_.toString-5.html +++ /dev/null @@ -1 +0,0 @@ -toString | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                    Function toStringAbstract

                                                                                                                                                                                                                                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                      • Optionalctx: StringifyContext
                                                                                                                                                                                                                                                                                                                                                                                                                      • OptionalonComment: () => void
                                                                                                                                                                                                                                                                                                                                                                                                                      • OptionalonChompKeep: () => void

                                                                                                                                                                                                                                                                                                                                                                                                                      Returns string

                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/functions/_internal_.toString.html b/docs/functions/_internal_.toString.html deleted file mode 100644 index 66798cc6..00000000 --- a/docs/functions/_internal_.toString.html +++ /dev/null @@ -1,2 +0,0 @@ -toString | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                      Function toString

                                                                                                                                                                                                                                                                                                                                                                                                                      • A YAML representation of the document.

                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                        Returns string

                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/functions/_internal_.unpipe-1.html b/docs/functions/_internal_.unpipe-1.html deleted file mode 100644 index 5b189249..00000000 --- a/docs/functions/_internal_.unpipe-1.html +++ /dev/null @@ -1,11 +0,0 @@ -unpipe | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                        Function unpipe

                                                                                                                                                                                                                                                                                                                                                                                                                        • The readable.unpipe() method detaches a Writable stream previously attached -using the pipe method.

                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                          If the destination is not specified, then all pipes are detached.

                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                          If the destination is specified, but no pipe is set up for it, then -the method does nothing.

                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                          import fs from 'node:fs';
                                                                                                                                                                                                                                                                                                                                                                                                                          const readable = getReadableStreamSomehow();
                                                                                                                                                                                                                                                                                                                                                                                                                          const writable = fs.createWriteStream('file.txt');
                                                                                                                                                                                                                                                                                                                                                                                                                          // All the data from readable goes into 'file.txt',
                                                                                                                                                                                                                                                                                                                                                                                                                          // but only for the first second.
                                                                                                                                                                                                                                                                                                                                                                                                                          readable.pipe(writable);
                                                                                                                                                                                                                                                                                                                                                                                                                          setTimeout(() => {
                                                                                                                                                                                                                                                                                                                                                                                                                            console.log('Stop writing to file.txt.');
                                                                                                                                                                                                                                                                                                                                                                                                                            readable.unpipe(writable);
                                                                                                                                                                                                                                                                                                                                                                                                                            console.log('Manually close the file stream.');
                                                                                                                                                                                                                                                                                                                                                                                                                            writable.end();
                                                                                                                                                                                                                                                                                                                                                                                                                          }, 1000);
-
                                                                                                                                                                                                                                                                                                                                                                                                                          - -

                                                                                                                                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                          • Optionaldestination: WritableStream

                                                                                                                                                                                                                                                                                                                                                                                                                            Optional specific stream to unpipe

                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                          Returns this

                                                                                                                                                                                                                                                                                                                                                                                                                          v0.9.4

                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/functions/_internal_.unpipe.html b/docs/functions/_internal_.unpipe.html deleted file mode 100644 index 52d50551..00000000 --- a/docs/functions/_internal_.unpipe.html +++ /dev/null @@ -1 +0,0 @@ -unpipe | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                          Function unpipe

                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                            Returns this

                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/functions/_internal_.unshift.html b/docs/functions/_internal_.unshift.html deleted file mode 100644 index e8713e2f..00000000 --- a/docs/functions/_internal_.unshift.html +++ /dev/null @@ -1 +0,0 @@ -unshift | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                            Function unshift

                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/functions/_internal_.updateHttpClientConfig.html b/docs/functions/_internal_.updateHttpClientConfig.html deleted file mode 100644 index b86083b5..00000000 --- a/docs/functions/_internal_.updateHttpClientConfig.html +++ /dev/null @@ -1 +0,0 @@ -updateHttpClientConfig | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                              Function updateHttpClientConfig

                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/functions/_internal_.when.html b/docs/functions/_internal_.when.html deleted file mode 100644 index 81282ba5..00000000 --- a/docs/functions/_internal_.when.html +++ /dev/null @@ -1 +0,0 @@ -when | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                Function when

                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/functions/_internal_.whenAnyAncestor.html b/docs/functions/_internal_.whenAnyAncestor.html deleted file mode 100644 index 63802df5..00000000 --- a/docs/functions/_internal_.whenAnyAncestor.html +++ /dev/null @@ -1 +0,0 @@ -whenAnyAncestor | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                  Function whenAnyAncestor

                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/functions/_internal_.whenAnyAncestorIs.html b/docs/functions/_internal_.whenAnyAncestorIs.html deleted file mode 100644 index e9ab953a..00000000 --- a/docs/functions/_internal_.whenAnyAncestorIs.html +++ /dev/null @@ -1 +0,0 @@ -whenAnyAncestorIs | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                    Function whenAnyAncestorIs

                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/functions/_internal_.whenAnyAncestorNamed.html b/docs/functions/_internal_.whenAnyAncestorNamed.html deleted file mode 100644 index 4e643b28..00000000 --- a/docs/functions/_internal_.whenAnyAncestorNamed.html +++ /dev/null @@ -1 +0,0 @@ -whenAnyAncestorNamed | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                      Function whenAnyAncestorNamed

                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/functions/_internal_.whenAnyAncestorTagged.html b/docs/functions/_internal_.whenAnyAncestorTagged.html deleted file mode 100644 index 41fe4bcd..00000000 --- a/docs/functions/_internal_.whenAnyAncestorTagged.html +++ /dev/null @@ -1 +0,0 @@ -whenAnyAncestorTagged | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                        Function whenAnyAncestorTagged

                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/functions/_internal_.whenDefault.html b/docs/functions/_internal_.whenDefault.html deleted file mode 100644 index 04f0dfc7..00000000 --- a/docs/functions/_internal_.whenDefault.html +++ /dev/null @@ -1 +0,0 @@ -whenDefault | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                          Function whenDefault

                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/functions/_internal_.whenNamed.html b/docs/functions/_internal_.whenNamed.html deleted file mode 100644 index d5ee5574..00000000 --- a/docs/functions/_internal_.whenNamed.html +++ /dev/null @@ -1 +0,0 @@ -whenNamed | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                            Function whenNamed

                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/functions/_internal_.whenNoAncestorIs.html b/docs/functions/_internal_.whenNoAncestorIs.html deleted file mode 100644 index 4f4cfb6e..00000000 --- a/docs/functions/_internal_.whenNoAncestorIs.html +++ /dev/null @@ -1 +0,0 @@ -whenNoAncestorIs | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                              Function whenNoAncestorIs

                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/functions/_internal_.whenNoAncestorNamed.html b/docs/functions/_internal_.whenNoAncestorNamed.html deleted file mode 100644 index c54c0877..00000000 --- a/docs/functions/_internal_.whenNoAncestorNamed.html +++ /dev/null @@ -1 +0,0 @@ -whenNoAncestorNamed | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                Function whenNoAncestorNamed

                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/functions/_internal_.whenNoAncestorTagged.html b/docs/functions/_internal_.whenNoAncestorTagged.html deleted file mode 100644 index 0aca186c..00000000 --- a/docs/functions/_internal_.whenNoAncestorTagged.html +++ /dev/null @@ -1 +0,0 @@ -whenNoAncestorTagged | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function whenNoAncestorTagged

                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/functions/_internal_.whenNoParent.html b/docs/functions/_internal_.whenNoParent.html deleted file mode 100644 index cf337575..00000000 --- a/docs/functions/_internal_.whenNoParent.html +++ /dev/null @@ -1 +0,0 @@ -whenNoParent | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function whenNoParent

                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/functions/_internal_.whenNoParentIs.html b/docs/functions/_internal_.whenNoParentIs.html deleted file mode 100644 index a7875ba2..00000000 --- a/docs/functions/_internal_.whenNoParentIs.html +++ /dev/null @@ -1 +0,0 @@ -whenNoParentIs | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function whenNoParentIs

                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/functions/_internal_.whenNoParentNamed.html b/docs/functions/_internal_.whenNoParentNamed.html deleted file mode 100644 index 630339c5..00000000 --- a/docs/functions/_internal_.whenNoParentNamed.html +++ /dev/null @@ -1 +0,0 @@ -whenNoParentNamed | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function whenNoParentNamed

                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/functions/_internal_.whenNoParentTagged.html b/docs/functions/_internal_.whenNoParentTagged.html deleted file mode 100644 index cb40df7f..00000000 --- a/docs/functions/_internal_.whenNoParentTagged.html +++ /dev/null @@ -1 +0,0 @@ -whenNoParentTagged | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function whenNoParentTagged

                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/functions/_internal_.whenParent.html b/docs/functions/_internal_.whenParent.html deleted file mode 100644 index d76ed5cc..00000000 --- a/docs/functions/_internal_.whenParent.html +++ /dev/null @@ -1 +0,0 @@ -whenParent | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function whenParent

                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/functions/_internal_.whenParentIs.html b/docs/functions/_internal_.whenParentIs.html deleted file mode 100644 index fe6f3f7c..00000000 --- a/docs/functions/_internal_.whenParentIs.html +++ /dev/null @@ -1 +0,0 @@ -whenParentIs | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function whenParentIs

                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/functions/_internal_.whenParentNamed.html b/docs/functions/_internal_.whenParentNamed.html deleted file mode 100644 index 1b46f2a2..00000000 --- a/docs/functions/_internal_.whenParentNamed.html +++ /dev/null @@ -1 +0,0 @@ -whenParentNamed | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function whenParentNamed

                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/functions/_internal_.whenParentTagged.html b/docs/functions/_internal_.whenParentTagged.html deleted file mode 100644 index 688c8884..00000000 --- a/docs/functions/_internal_.whenParentTagged.html +++ /dev/null @@ -1 +0,0 @@ -whenParentTagged | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function whenParentTagged

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/functions/_internal_.whenTagged.html b/docs/functions/_internal_.whenTagged.html deleted file mode 100644 index f885e9cd..00000000 --- a/docs/functions/_internal_.whenTagged.html +++ /dev/null @@ -1 +0,0 @@ -whenTagged | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function whenTagged

                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/functions/_internal_.wrap-1.html b/docs/functions/_internal_.wrap-1.html deleted file mode 100644 index 514f8488..00000000 --- a/docs/functions/_internal_.wrap-1.html +++ /dev/null @@ -1,14 +0,0 @@ -wrap | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function wrap

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Prior to Node.js 0.10, streams did not implement the entire node:stream module API as it is currently defined. (See Compatibility for more -information.)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                        When using an older Node.js library that emits 'data' events and has a pause method that is advisory only, the readable.wrap() method can be used to create a Readable -stream that uses -the old stream as its data source.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                        It will rarely be necessary to use readable.wrap() but the method has been -provided as a convenience for interacting with older Node.js applications and -libraries.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        import { OldReader } from './old-api-module.js';
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        import { Readable } from 'node:stream';
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        const oreader = new OldReader();
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        const myReader = new Readable().wrap(oreader);

                                                                                                                                                                                                                                                                                                                                                                                                                                                                        myReader.on('readable', () => {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          myReader.read(); // etc.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        });
-
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        - -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                        v0.9.4

                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/functions/_internal_.wrap.html b/docs/functions/_internal_.wrap.html deleted file mode 100644 index 4fe1b71a..00000000 --- a/docs/functions/_internal_.wrap.html +++ /dev/null @@ -1 +0,0 @@ -wrap | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function wrap

                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/functions/_internal_.write-1.html b/docs/functions/_internal_.write-1.html deleted file mode 100644 index 013f9672..00000000 --- a/docs/functions/_internal_.write-1.html +++ /dev/null @@ -1 +0,0 @@ -write | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function writeOptional

                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/functions/_internal_.write-2.html b/docs/functions/_internal_.write-2.html deleted file mode 100644 index cea01fbd..00000000 --- a/docs/functions/_internal_.write-2.html +++ /dev/null @@ -1,74 +0,0 @@ -write | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function write

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • The writable.write() method writes some data to the stream, and calls the -supplied callback once the data has been fully handled. If an error -occurs, the callback will be called with the error as its -first argument. The callback is called asynchronously and before 'error' is -emitted.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The return value is true if the internal buffer is less than the highWaterMark configured when the stream was created after admitting chunk. -If false is returned, further attempts to write data to the stream should -stop until the 'drain' event is emitted.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              While a stream is not draining, calls to write() will buffer chunk, and -return false. Once all currently buffered chunks are drained (accepted for -delivery by the operating system), the 'drain' event will be emitted. -Once write() returns false, do not write more chunks -until the 'drain' event is emitted. While calling write() on a stream that -is not draining is allowed, Node.js will buffer all written chunks until -maximum memory usage occurs, at which point it will abort unconditionally. -Even before it aborts, high memory usage will cause poor garbage collector -performance and high RSS (which is not typically released back to the system, -even after the memory is no longer required). Since TCP sockets may never -drain if the remote peer does not read the data, writing a socket that is -not draining may lead to a remotely exploitable vulnerability.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Writing data while the stream is not draining is particularly -problematic for a Transform, because the Transform streams are paused -by default until they are piped or a 'data' or 'readable' event handler -is added.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              If the data to be written can be generated or fetched on demand, it is -recommended to encapsulate the logic into a Readable and use pipe. However, if calling write() is preferred, it is -possible to respect backpressure and avoid memory issues using the 'drain' event:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              function write(data, cb) {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                if (!stream.write(data)) {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  stream.once('drain', cb);
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                } else {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  process.nextTick(cb);
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              // Wait for cb to be called before doing any other write.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              write('hello', () => {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                console.log('Write completed, do more writes now.');
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              });
-
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              - -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              A Writable stream in object mode will always ignore the encoding argument.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • chunk: any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Optional data to write. For streams not operating in object mode, chunk must be a {string}, {Buffer}, -{TypedArray} or {DataView}. For object mode streams, chunk may be any JavaScript value other than null.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Optionalcallback: (error: Error) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Callback for when this chunk of data is flushed.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              false if the stream wishes for the calling code to wait for the 'drain' event to be emitted before continuing to write additional data; otherwise true.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              v0.9.4

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • The writable.write() method writes some data to the stream, and calls the -supplied callback once the data has been fully handled. If an error -occurs, the callback will be called with the error as its -first argument. The callback is called asynchronously and before 'error' is -emitted.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The return value is true if the internal buffer is less than the highWaterMark configured when the stream was created after admitting chunk. -If false is returned, further attempts to write data to the stream should -stop until the 'drain' event is emitted.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              While a stream is not draining, calls to write() will buffer chunk, and -return false. Once all currently buffered chunks are drained (accepted for -delivery by the operating system), the 'drain' event will be emitted. -Once write() returns false, do not write more chunks -until the 'drain' event is emitted. While calling write() on a stream that -is not draining is allowed, Node.js will buffer all written chunks until -maximum memory usage occurs, at which point it will abort unconditionally. -Even before it aborts, high memory usage will cause poor garbage collector -performance and high RSS (which is not typically released back to the system, -even after the memory is no longer required). Since TCP sockets may never -drain if the remote peer does not read the data, writing a socket that is -not draining may lead to a remotely exploitable vulnerability.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Writing data while the stream is not draining is particularly -problematic for a Transform, because the Transform streams are paused -by default until they are piped or a 'data' or 'readable' event handler -is added.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              If the data to be written can be generated or fetched on demand, it is -recommended to encapsulate the logic into a Readable and use pipe. However, if calling write() is preferred, it is -possible to respect backpressure and avoid memory issues using the 'drain' event:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              function write(data, cb) {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                if (!stream.write(data)) {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  stream.once('drain', cb);
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                } else {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  process.nextTick(cb);
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              // Wait for cb to be called before doing any other write.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              write('hello', () => {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                console.log('Write completed, do more writes now.');
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              });
-
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              - -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              A Writable stream in object mode will always ignore the encoding argument.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • chunk: any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Optional data to write. For streams not operating in object mode, chunk must be a {string}, {Buffer}, -{TypedArray} or {DataView}. For object mode streams, chunk may be any JavaScript value other than null.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • encoding: BufferEncoding

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                The encoding, if chunk is a string.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Optionalcallback: (error: Error) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Callback for when this chunk of data is flushed.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              false if the stream wishes for the calling code to wait for the 'drain' event to be emitted before continuing to write additional data; otherwise true.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              v0.9.4

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/functions/_internal_.write.html b/docs/functions/_internal_.write.html deleted file mode 100644 index 9c458c6c..00000000 --- a/docs/functions/_internal_.write.html +++ /dev/null @@ -1 +0,0 @@ -write | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function write

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • buffer: string | Uint8Array<ArrayBufferLike>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Optionalcb: (err?: Error) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • str: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Optionalencoding: BufferEncoding
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Optionalcb: (err?: Error) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/functions/_internal_.writev.html b/docs/functions/_internal_.writev.html deleted file mode 100644 index ac7fe5a4..00000000 --- a/docs/functions/_internal_.writev.html +++ /dev/null @@ -1 +0,0 @@ -writev | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function writevOptional

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • this: T
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • chunks: { chunk: any; encoding: BufferEncoding }[]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • callback: (error?: Error) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/functions/api.html b/docs/functions/api.html index c2ebaf8e..27cf06bb 100644 --- a/docs/functions/api.html +++ b/docs/functions/api.html @@ -1,4 +1,4 @@ api | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  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 60d2332d..d5ca14c6 100644 --- a/docs/functions/apiController.html +++ b/docs/functions/apiController.html @@ -1,4 +1,4 @@ apiController | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    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 ccffdd5e..5c8e3fbe 100644 --- a/docs/functions/apiIgnore.html +++ b/docs/functions/apiIgnore.html @@ -1,3 +1,3 @@ apiIgnore | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      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 f2bb4f82..f7264285 100644 --- a/docs/functions/apiIgnoreController.html +++ b/docs/functions/apiIgnoreController.html @@ -1,3 +1,3 @@ apiIgnoreController | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        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 f68df257..9295978a 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 32166237..af30b967 100644 --- a/docs/functions/apiRequest.html +++ b/docs/functions/apiRequest.html @@ -1,4 +1,4 @@ apiRequest | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          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 0f25cf45..71f9154c 100644 --- a/docs/functions/apiResponse.html +++ b/docs/functions/apiResponse.html @@ -1,5 +1,5 @@ apiResponse | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function apiResponse

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Decorator that can be placed on an endpoint to describe a possible response 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
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • OptionalapiBodyInfo: ApiBody

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Information about the response body generated.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/functions/apiSecurity.html b/docs/functions/apiSecurity.html index f1460b4a..4a740dae 100644 --- a/docs/functions/apiSecurity.html +++ b/docs/functions/apiSecurity.html @@ -1,5 +1,5 @@ apiSecurity | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function apiSecurity

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Decorator for a auth filter implementation to describe it in any generated 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
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • securitySchemeInfo: SecuritySchemeObject

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              openapi3-ts security scheme model.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Returns (classDefinition: Function) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/functions/body.html b/docs/functions/body.html index 24accd1b..1b33b0c7 100644 --- a/docs/functions/body.html +++ b/docs/functions/body.html @@ -1,4 +1,4 @@ body | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                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 6c0c01fd..fb310057 100644 --- a/docs/functions/consumes.html +++ b/docs/functions/consumes.html @@ -1,4 +1,4 @@ consumes | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  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 9b3d4f0c..68745a64 100644 --- a/docs/functions/controllerConsumes.html +++ b/docs/functions/controllerConsumes.html @@ -1,4 +1,4 @@ controllerConsumes | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    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 b1658859..94260906 100644 --- a/docs/functions/controllerErrorInterceptor.html +++ b/docs/functions/controllerErrorInterceptor.html @@ -1,3 +1,3 @@ controllerErrorInterceptor | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      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 ebaaf9f9..db162391 100644 --- a/docs/functions/controllerNoAuth.html +++ b/docs/functions/controllerNoAuth.html @@ -1,2 +1,2 @@ controllerNoAuth | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function controllerNoAuth

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Decorator for a controller class that marks it not requiring authentication for any of it's endpoints.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • classDefinition: Function

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • classDefinition: Function

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/functions/controllerProduces.html b/docs/functions/controllerProduces.html index 44f78d97..08565f8a 100644 --- a/docs/functions/controllerProduces.html +++ b/docs/functions/controllerProduces.html @@ -1,4 +1,4 @@ controllerProduces | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          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 dcff1305..a2f9f6fb 100644 --- a/docs/functions/controllerRolesAllowed.html +++ b/docs/functions/controllerRolesAllowed.html @@ -3,4 +3,4 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Role based authorization is managed by a IAuthorizer implementation registered with the current app.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • ...roleNames: string[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Names of roles that are permitted to use the endpoints in this controller.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns (classDefinition: Function) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns (classDefinition: Function) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/functions/errorInterceptor.html b/docs/functions/errorInterceptor.html index 4187dc0c..896fb48b 100644 --- a/docs/functions/errorInterceptor.html +++ b/docs/functions/errorInterceptor.html @@ -1,4 +1,4 @@ errorInterceptor | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            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 8760315c..e04c4906 100644 --- a/docs/functions/header.html +++ b/docs/functions/header.html @@ -1,4 +1,4 @@ header | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              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 c1044f50..64c03ad6 100644 --- a/docs/functions/noAuth.html +++ b/docs/functions/noAuth.html @@ -1,2 +1,2 @@ noAuth | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function noAuth

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Decorator for an endpoint method that marks it as not requiring authentication.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • classDefinition: object | Function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • methodName: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • classDefinition: object | Function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • methodName: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/functions/pathParam.html b/docs/functions/pathParam.html index b6a1ac24..9a51b362 100644 --- a/docs/functions/pathParam.html +++ b/docs/functions/pathParam.html @@ -1,5 +1,5 @@ pathParam | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function pathParam

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Decorator which injects a path parameter value as an endpoint parameter value.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Value passed to the method will be a string.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • paramName: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The name of the path parameter to inject.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • OptionalapiParamInfo: ApiParam

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      (Optional) OpenApi metadata about the path parameter.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        classDefinition: object | Function,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        methodName: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        paramIndex: number,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • OptionalapiParamInfo: ApiParam

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  (Optional) OpenApi metadata about the path parameter.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • 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 807c4503..22417587 100644 --- a/docs/functions/principal.html +++ b/docs/functions/principal.html @@ -1,3 +1,3 @@ principal | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function principal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Decorator which injects the current authentication principal as a parameter value.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Value passed to the method will be an implementation of the Principal interface.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • classDefinition: object | Function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • methodName: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • paramIndex: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • classDefinition: object | Function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • methodName: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • paramIndex: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/functions/produces.html b/docs/functions/produces.html index 83928632..651ea9d6 100644 --- a/docs/functions/produces.html +++ b/docs/functions/produces.html @@ -1,4 +1,4 @@ produces | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      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 a33f2131..03a92262 100644 --- a/docs/functions/queryParam.html +++ b/docs/functions/queryParam.html @@ -1,4 +1,4 @@ queryParam | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        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 7100b2e6..f6ae5e62 100644 --- a/docs/functions/rawBody.html +++ b/docs/functions/rawBody.html @@ -1,3 +1,3 @@ rawBody | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function rawBody

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Decorator which injects the raw HTTP request body as a parameter value.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Value passed to the method will be a Buffer.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • classDefinition: object | Function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • methodName: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • paramIndex: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • classDefinition: object | Function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • methodName: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • paramIndex: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/functions/request.html b/docs/functions/request.html index b35bc87e..0bf6649c 100644 --- a/docs/functions/request.html +++ b/docs/functions/request.html @@ -1,3 +1,3 @@ request | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function request

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Decorator which injects a the current HTTP request context as a parameter value.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Value passed to the method will be of type Request from the lambda-api package.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • classDefinition: object | Function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • methodName: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • paramIndex: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • classDefinition: object | Function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • methodName: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • paramIndex: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/functions/response.html b/docs/functions/response.html index fedd3808..b02a2b7e 100644 --- a/docs/functions/response.html +++ b/docs/functions/response.html @@ -1,3 +1,3 @@ response | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function response

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Decorator which injects a the current HTTP response context as a parameter value.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Value passed to the method will be of type Response from the lambda-api package.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • classDefinition: object | Function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • methodName: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • paramIndex: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • classDefinition: object | Function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • methodName: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • paramIndex: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/functions/rolesAllowed.html b/docs/functions/rolesAllowed.html index dbc08396..2859297a 100644 --- a/docs/functions/rolesAllowed.html +++ b/docs/functions/rolesAllowed.html @@ -3,4 +3,4 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Role based authorization is managed by an IAuthorizer implementation registered with the current app.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • ...roleNames: string[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Names of roles that are permitted to use the endpoint.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/functions/timed.html b/docs/functions/timed.html index d35cff07..03ba0214 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 033d93a6..6a75bf08 100644 --- a/docs/hierarchy.html +++ b/docs/hierarchy.html @@ -1 +1 @@ -ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.2

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Hierarchy Summary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.2

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy Summary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/index.html b/docs/index.html index c49161e2..e7f7ad3f 100644 --- a/docs/index.html +++ b/docs/index.html @@ -253,7 +253,7 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  This framework supports authenticating requests and authorization for controllers and endpoints. It can be used to configure HTTP authentication, token based auth and role based access control (ACLs).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Implementation is heavily inspired by the Dropwizard framework for Java.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  @@ -375,7 +375,7 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Request / Response Context

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  If you want to read request bodies or write to the response, there are several supported approaches.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  If you extend the controller class, you get access to the request and response context.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  @@ -583,4 +583,4 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns Promise<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Instance of type T or undefined on extraction failure.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/interfaces/IAuthorizer.html b/docs/interfaces/IAuthorizer.html index 9fc4e3bb..48b8f908 100644 --- a/docs/interfaces/IAuthorizer.html +++ b/docs/interfaces/IAuthorizer.html @@ -3,8 +3,8 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  interface IAuthorizer<T extends Principal> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      name: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      authorize(principal: T, role: string): Promise<boolean>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  authorize

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  name: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  A human readable name for this authorizer.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Check that a principal has a named role.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • principal: T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The current principal context.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • role: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The name of the role to check for.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns Promise<boolean>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    true if the principal is authorised to use the name role, otherwise false.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • role: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The name of the role to check for.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Returns Promise<boolean>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  true if the principal is authorised to use the name role, otherwise false.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/interfaces/ILogger.html b/docs/interfaces/ILogger.html index 418057c2..f3fefe80 100644 --- a/docs/interfaces/ILogger.html +++ b/docs/interfaces/ILogger.html @@ -1,5 +1,5 @@ ILogger | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    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.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • ...formatArgs: any[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      (Optional) Arguments which are passed to sprintf to format the 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.

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      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.

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      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.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • ...formatArgs: any[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      (Optional) Arguments which are passed to sprintf to format the 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?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • ...formatArgs: any[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      (Optional) Arguments which are passed to sprintf to format the message.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    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.

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      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.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • ...formatArgs: any[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      (Optional) Arguments which are passed to sprintf to format the 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
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • ...formatArgs: any[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    (Optional) Arguments which are passed to sprintf to format the message.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Returns any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/interfaces/_internal_.APIGatewayEventIdentity.html b/docs/interfaces/_internal_.APIGatewayEventIdentity.html index 61645c4f..8d33c3d6 100644 --- a/docs/interfaces/_internal_.APIGatewayEventIdentity.html +++ b/docs/interfaces/_internal_.APIGatewayEventIdentity.html @@ -1,4 +1,4 @@ -APIGatewayEventIdentity | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Interface APIGatewayEventIdentity

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      interface APIGatewayEventIdentity {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          accessKey: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          accountId: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          apiKey: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          apiKeyId: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          caller: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          clientCert: APIGatewayEventClientCertificate;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          cognitoAuthenticationProvider: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          cognitoAuthenticationType: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          cognitoIdentityId: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          cognitoIdentityPoolId: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          principalOrgId: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          sourceIp: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          user: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          userAgent: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          userArn: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      accessKey +APIGatewayEventIdentity | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Interface APIGatewayEventIdentity

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        interface APIGatewayEventIdentity {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            accessKey: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            accountId: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            apiKey: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            apiKeyId: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            caller: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            clientCert: APIGatewayEventClientCertificate;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            cognitoAuthenticationProvider: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            cognitoAuthenticationType: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            cognitoIdentityId: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            cognitoIdentityPoolId: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            principalOrgId: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            sourceIp: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            user: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            userAgent: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            userArn: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            vpceId?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            vpcId?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        accessKey accountId apiKey apiKeyId @@ -13,4 +13,6 @@ user userAgent userArn -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        accessKey: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        accountId: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        apiKey: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        apiKeyId: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        caller: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        clientCert: APIGatewayEventClientCertificate
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        cognitoAuthenticationProvider: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        cognitoAuthenticationType: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        cognitoIdentityId: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        cognitoIdentityPoolId: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        principalOrgId: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        sourceIp: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        user: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        userAgent: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        userArn: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +vpceId? +vpcId? +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        accessKey: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        accountId: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        apiKey: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        apiKeyId: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        caller: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        clientCert: APIGatewayEventClientCertificate
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        cognitoAuthenticationProvider: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        cognitoAuthenticationType: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        cognitoIdentityId: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        cognitoIdentityPoolId: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        principalOrgId: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        sourceIp: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        user: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        userAgent: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        userArn: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        vpceId?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        vpcId?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/interfaces/_internal_.APIGatewayProxyEventV2WithRequestContext.html b/docs/interfaces/_internal_.APIGatewayProxyEventV2WithRequestContext.html index 41371d64..f0e994f1 100644 --- a/docs/interfaces/_internal_.APIGatewayProxyEventV2WithRequestContext.html +++ b/docs/interfaces/_internal_.APIGatewayProxyEventV2WithRequestContext.html @@ -1,5 +1,5 @@ APIGatewayProxyEventV2WithRequestContext | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Interface APIGatewayProxyEventV2WithRequestContext<TRequestContext>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Proxy Event with adaptable requestContext for different authorizer scenarios

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          interface APIGatewayProxyEventV2WithRequestContext<TRequestContext> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              body?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              cookies?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              headers: APIGatewayProxyEventHeaders;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              isBase64Encoded: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              pathParameters?: APIGatewayProxyEventPathParameters;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              queryStringParameters?: APIGatewayProxyEventQueryStringParameters;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              rawPath: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              rawQueryString: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              requestContext: TRequestContext;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              routeKey: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              stageVariables?: APIGatewayProxyEventStageVariables;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              version: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • TRequestContext
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          body? +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          interface APIGatewayProxyEventV2WithRequestContext<TRequestContext> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              body?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              cookies?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              headers: APIGatewayProxyEventHeaders;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              isBase64Encoded: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              pathParameters?: APIGatewayProxyEventPathParameters;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              queryStringParameters?: APIGatewayProxyEventQueryStringParameters;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              rawPath: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              rawQueryString: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              requestContext: TRequestContext;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              routeKey: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              stageVariables?: APIGatewayProxyEventStageVariables;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              version: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • TRequestContext
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          body? cookies? headers isBase64Encoded diff --git a/docs/interfaces/_internal_.AbortSignal-1.html b/docs/interfaces/_internal_.AbortSignal-1.html index f8bba585..1a2f6d4b 100644 --- a/docs/interfaces/_internal_.AbortSignal-1.html +++ b/docs/interfaces/_internal_.AbortSignal-1.html @@ -5,6 +5,6 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          interface AbortSignal {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              aborted: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              onabort: Function | AbortHandler;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          aborted onabort

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          aborted: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Whether the action represented by this signal has been cancelled.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          onabort: Function | AbortHandler

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          A function to be invoked when the action represented by this signal has +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          onabort: Function | AbortHandler

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          A function to be invoked when the action represented by this signal has been cancelled.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/interfaces/_internal_.AbortSignal-2.html b/docs/interfaces/_internal_.AbortSignal-2.html new file mode 100644 index 00000000..c46608be --- /dev/null +++ b/docs/interfaces/_internal_.AbortSignal-2.html @@ -0,0 +1,8 @@ +AbortSignal | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            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 +dispatchEvent +removeEventListener +throwIfAborted +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            aborted: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            onabort: (this: AbortSignal, ev: Event) => any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            reason: any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/interfaces/_internal_.AbortSignal.html b/docs/interfaces/_internal_.AbortSignal.html index fce5935d..4b0c31ed 100644 --- a/docs/interfaces/_internal_.AbortSignal.html +++ b/docs/interfaces/_internal_.AbortSignal.html @@ -1,8 +1,8 @@ -AbortSignal | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              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 +AbortSignal | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                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 dispatchEvent removeEventListener -throwIfAborted -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                aborted: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                onabort: (this: AbortSignal, ev: Event) => any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                reason: any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +throwIfAborted +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                aborted: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                onabort: (this: AbortSignal, ev: Event) => any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                reason: any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/interfaces/_internal_.AddEventListenerOptions.html b/docs/interfaces/_internal_.AddEventListenerOptions.html index 6220e910..2855c2aa 100644 --- a/docs/interfaces/_internal_.AddEventListenerOptions.html +++ b/docs/interfaces/_internal_.AddEventListenerOptions.html @@ -1,5 +1,5 @@ -AddEventListenerOptions | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  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.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Interface AddEventListenerOptions

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    capture? once? passive? signal? -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    capture?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    once?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    passive?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    signal?: AbortSignal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    capture?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    once?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    passive?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    signal?: AbortSignal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/interfaces/_internal_.AddOperation.html b/docs/interfaces/_internal_.AddOperation.html index 03016ac5..e55a74eb 100644 --- a/docs/interfaces/_internal_.AddOperation.html +++ b/docs/interfaces/_internal_.AddOperation.html @@ -1,4 +1,4 @@ -AddOperation | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      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.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        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_.AddressInfo.html b/docs/interfaces/_internal_.AddressInfo.html index 5fc5b06f..924e7423 100644 --- a/docs/interfaces/_internal_.AddressInfo.html +++ b/docs/interfaces/_internal_.AddressInfo.html @@ -1,4 +1,4 @@ -AddressInfo | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Interface AddressInfo

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          interface AddressInfo {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              address: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              family: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              port: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          address +AddressInfo | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Interface AddressInfo

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            interface AddressInfo {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                address: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                family: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                port: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            address family port -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            address: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            family: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            port: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            address: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            family: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            port: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/interfaces/_internal_.AgentOptions-1.html b/docs/interfaces/_internal_.AgentOptions-1.html index 0c6be5fb..0b164b9e 100644 --- a/docs/interfaces/_internal_.AgentOptions-1.html +++ b/docs/interfaces/_internal_.AgentOptions-1.html @@ -1,5 +1,5 @@ -AgentOptions | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Interface AgentOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Make all properties in T optional

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              interface AgentOptions {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  allowPartialTrustChain?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ALPNCallback?: (arg: { protocols: string[]; servername: string }) => string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ALPNProtocols?:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | string[]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | Uint8Array<ArrayBufferLike>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | Uint8Array<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>)[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  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;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  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;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  pskCallback(hint: string): PSKCallbackNegotation;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              allowPartialTrustChain? +AgentOptions | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                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? autoSelectFamily? @@ -11,6 +11,7 @@ ciphers? clientCertEngine? crl? +defaultPort? dhparam? ecdhCurve? enableTrace? @@ -39,6 +40,9 @@ port? privateKeyEngine? privateKeyIdentifier? +protocol? +proxyEnv? +pskCallback? rejectUnauthorized? requestCert? scheduling? @@ -54,11 +58,19 @@ socket? ticketKeys? timeout? -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                pskCallback? -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                allowPartialTrustChain?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Treat intermediate (non-self-signed) +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                agentKeepAliveTimeoutBuffer?: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Milliseconds to subtract from +the server-provided keep-alive: timeout=... hint when determining socket +expiration time. This buffer helps ensure the agent closes the socket +slightly before the server does, reducing the chance of sending a request +on a socket that’s about to be closed by the server.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                v24.7.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                1000
+
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                allowPartialTrustChain?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Treat intermediate (non-self-signed) certificates in the trust CA certificate list as trusted.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                v22.9.0, v20.18.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ALPNCallback?: (arg: { protocols: string[]; servername: string }) => string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                If set, this will be called when a client opens a connection using the ALPN extension. +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                v22.9.0, v20.18.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ALPNCallback?: (arg: { protocols: string[]; servername: string }) => string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                If set, this will be called when a client opens a connection using the ALPN extension. One argument will be passed to the callback: an object containing servername and protocols fields, respectively containing the server name from the SNI extension (if any) and an array of ALPN protocol name strings. The callback must return either one of the strings listed in protocols, @@ -66,14 +78,14 @@ to reject the connection with a fatal alert. If a string is returned that does not match one of the client's ALPN protocols, an error will be thrown. This option cannot be used with the ALPNProtocols option, and setting both options will throw an error.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ALPNProtocols?:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | string[]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | Uint8Array<ArrayBufferLike>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | Uint8Array<ArrayBufferLike>[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                An array of strings or a Buffer naming possible ALPN protocols. +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ALPNProtocols?: readonly string[] | ArrayBufferView<ArrayBufferLike>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                An array of strings or a Buffer naming possible ALPN protocols. (Protocols should be ordered by their priority.)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                autoSelectFamily?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                v18.13.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                autoSelectFamilyAttemptTimeout?: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                v18.13.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                blockList?: BlockList
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ca?: string | Buffer<ArrayBufferLike> | (string | Buffer<ArrayBufferLike>)[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Optionally override the trusted CA certificates. Default is to trust +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                autoSelectFamily?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                v18.13.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                autoSelectFamilyAttemptTimeout?: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                v18.13.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                blockList?: BlockList
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ca?: string | Buffer<ArrayBufferLike> | (string | Buffer<ArrayBufferLike>)[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Optionally override the trusted CA certificates. Default is to trust the well-known CAs curated by Mozilla. Mozilla's CAs are completely replaced when CAs are explicitly specified using this option.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                cert?: string | Buffer<ArrayBufferLike> | (string | Buffer<ArrayBufferLike>)[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Cert chains in PEM format. One cert chain should be provided per +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                cert?: string | Buffer<ArrayBufferLike> | (string | Buffer<ArrayBufferLike>)[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Cert chains in PEM format. One cert chain should be provided per private key. Each cert chain should consist of the PEM formatted certificate for a provided private key, followed by the PEM formatted intermediate certificates (if any), in order, and not @@ -82,7 +94,7 @@ be in the same order as their private keys in key. If the intermediate certificates are not provided, the peer will not be able to validate the certificate, and the handshake will fail.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                checkServerIdentity?: (hostname: string, cert: PeerCertificate) => Error

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • (hostname: string, cert: PeerCertificate): Error

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Verifies the certificate cert is issued to hostname.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                checkServerIdentity?: (hostname: string, cert: PeerCertificate) => Error

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • (hostname: string, cert: PeerCertificate): Error

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Verifies the certificate cert is issued to hostname.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns Error object, populating it with reason, host, and cert on failure. On success, returns undefined.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    This function is intended to be used in combination with thecheckServerIdentity option that can be passed to connect and as @@ -96,36 +108,38 @@ was present (see CVE-2021-44531). Applications that wish to acceptuniformResourceIdentifier subject alternative names can use a custom options.checkServerIdentity function that implements the desired behavior.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • hostname: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The host name or IP address to verify the certificate against.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • cert: PeerCertificate

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      A certificate object representing the peer's certificate.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns Error

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    v0.8.4

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ciphers?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Cipher suite specification, replacing the default. For more +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • cert: PeerCertificate

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                A certificate object representing the peer's certificate.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Returns Error

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                v0.8.4

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ciphers?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Cipher suite specification, replacing the default. For more information, see modifying the default cipher suite. Permitted ciphers can be obtained via tls.getCiphers(). Cipher names must be uppercased in order for OpenSSL to accept them.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                clientCertEngine?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Name of an OpenSSL engine which can provide the client certificate.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                crl?: string | Buffer<ArrayBufferLike> | (string | Buffer<ArrayBufferLike>)[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                PEM formatted CRLs (Certificate Revocation Lists).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                dhparam?: string | Buffer<ArrayBufferLike>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                'auto' or custom Diffie-Hellman parameters, required for non-ECDHE perfect forward secrecy. +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                clientCertEngine?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Name of an OpenSSL engine which can provide the client certificate.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                crl?: string | Buffer<ArrayBufferLike> | (string | Buffer<ArrayBufferLike>)[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                PEM formatted CRLs (Certificate Revocation Lists).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                defaultPort?: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Default port to use when the port is not specified in requests.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                v24.5.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                dhparam?: string | Buffer<ArrayBufferLike>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                'auto' or custom Diffie-Hellman parameters, required for non-ECDHE perfect forward secrecy. If omitted or invalid, the parameters are silently discarded and DHE ciphers will not be available. ECDHE-based perfect forward secrecy will still be available.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ecdhCurve?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                A string describing a named curve or a colon separated list of curve +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ecdhCurve?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                A string describing a named curve or a colon separated list of curve NIDs or names, for example P-521:P-384:P-256, to use for ECDH key agreement. Set to auto to select the curve automatically. Use crypto.getCurves() to obtain a list of available curve names. On recent releases, openssl ecparam -list_curves will also display the name and description of each available elliptic curve. Default: tls.DEFAULT_ECDH_CURVE.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                enableTrace?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                When enabled, TLS packet trace information is written to stderr. This can be +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                enableTrace?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                When enabled, TLS packet trace information is written to stderr. This can be used to debug TLS connection problems.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                false
+
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                family?: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                hints?: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                honorCipherOrder?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Attempt to use the server's cipher suite preferences instead of the +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                family?: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                hints?: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                honorCipherOrder?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Attempt to use the server's cipher suite preferences instead of the client's. When true, causes SSL_OP_CIPHER_SERVER_PREFERENCE to be set in secureOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                host?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                keepAlive?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Keep sockets around in a pool to be used by other requests in the future. Default = false

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                keepAliveInitialDelay?: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                keepAliveMsecs?: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                When using HTTP KeepAlive, how often to send TCP KeepAlive packets over sockets being kept alive. Default = 1000. +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                host?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                keepAlive?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Keep sockets around in a pool to be used by other requests in the future. Default = false

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                keepAliveInitialDelay?: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                keepAliveMsecs?: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                When using HTTP KeepAlive, how often to send TCP KeepAlive packets over sockets being kept alive. Default = 1000. Only relevant if keepAlive is set to true.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                key?:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | Buffer<ArrayBufferLike>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | (string | Buffer<ArrayBufferLike> | KeyObject)[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Private keys in PEM format. PEM allows the option of private keys +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                key?:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | Buffer<ArrayBufferLike>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | (string | Buffer<ArrayBufferLike> | KeyObject)[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Private keys in PEM format. PEM allows the option of private keys being encrypted. Encrypted keys will be decrypted with options.passphrase. Multiple keys using different algorithms can be provided either as an array of unencrypted key strings or buffers, @@ -133,16 +147,16 @@ passphrase: ]}. The object form can only occur in an array. object.passphrase is optional. Encrypted keys will be decrypted with object.passphrase if provided, or options.passphrase if it is not.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                localAddress?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                localPort?: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                lookup?: LookupFunction
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                maxCachedSessions?: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                maxFreeSockets?: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Maximum number of sockets to leave open in a free state. Only relevant if keepAlive is set to true. Default = 256.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                maxSockets?: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Maximum number of sockets to allow per host. Default for Node 0.10 is 5, default for Node 0.12 is Infinity

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                maxTotalSockets?: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Maximum number of sockets allowed for all hosts in total. Each request will use a new socket until the maximum is reached. Default: Infinity.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                maxVersion?: SecureVersion

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Optionally set the maximum TLS version to allow. One +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                localAddress?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                localPort?: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                lookup?: LookupFunction
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                maxCachedSessions?: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                maxFreeSockets?: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Maximum number of sockets to leave open in a free state. Only relevant if keepAlive is set to true. Default = 256.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                maxSockets?: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Maximum number of sockets to allow per host. Default for Node 0.10 is 5, default for Node 0.12 is Infinity

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                maxTotalSockets?: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Maximum number of sockets allowed for all hosts in total. Each request will use a new socket until the maximum is reached. Default: Infinity.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                maxVersion?: SecureVersion

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Optionally set the maximum TLS version to allow. One of 'TLSv1.3', 'TLSv1.2', 'TLSv1.1', or 'TLSv1'. Cannot be specified along with the secureProtocol option, use one or the other. Default: 'TLSv1.3', unless changed using CLI options. Using --tls-max-v1.2 sets the default to 'TLSv1.2'. Using --tls-max-v1.3 sets the default to 'TLSv1.3'. If multiple of the options are provided, the highest maximum is used.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                minDHSize?: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                minVersion?: SecureVersion

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Optionally set the minimum TLS version to allow. One +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                minDHSize?: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                minVersion?: SecureVersion

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Optionally set the minimum TLS version to allow. One of 'TLSv1.3', 'TLSv1.2', 'TLSv1.1', or 'TLSv1'. Cannot be specified along with the secureProtocol option, use one or the other. It is not recommended to use less than TLSv1.2, but it may be required for interoperability. @@ -150,8 +164,8 @@ --tls-v1.0 sets the default to 'TLSv1'. Using --tls-v1.1 sets the default to 'TLSv1.1'. Using --tls-min-v1.3 sets the default to 'TLSv1.3'. If multiple of the options are provided, the lowest minimum is used.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                noDelay?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                passphrase?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Shared passphrase used for a single private key and/or a PFX.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                path?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                pfx?:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | Buffer<ArrayBufferLike>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | (string | Buffer<ArrayBufferLike> | PxfObject)[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                PFX or PKCS12 encoded private key and certificate chain. pfx is an +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                noDelay?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                passphrase?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Shared passphrase used for a single private key and/or a PFX.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                path?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                pfx?:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | Buffer<ArrayBufferLike>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | (string | Buffer<ArrayBufferLike> | PxfObject)[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                PFX or PKCS12 encoded private key and certificate chain. pfx is an alternative to providing key and cert individually. PFX is usually encrypted, if it is, passphrase will be used to decrypt it. Multiple PFX can be provided either as an array of unencrypted PFX buffers, @@ -159,27 +173,46 @@ passphrase: ]}. The object form can only occur in an array. object.passphrase is optional. Encrypted PFX will be decrypted with object.passphrase if provided, or options.passphrase if it is not.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                port?: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                privateKeyEngine?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Name of an OpenSSL engine to get private key from. Should be used +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                port?: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                privateKeyEngine?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Name of an OpenSSL engine to get private key from. Should be used together with privateKeyIdentifier.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                privateKeyIdentifier?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Identifier of a private key managed by an OpenSSL engine. Should be +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                privateKeyIdentifier?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Identifier of a private key managed by an OpenSSL engine. Should be used together with privateKeyEngine. Should not be set together with key, because both options define a private key in different ways.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                rejectUnauthorized?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                If true the server will reject any connection which is not +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                protocol?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                The protocol to use for the agent.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                v24.5.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                proxyEnv?: ProxyEnv

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Environment variables for proxy configuration. See +Built-in Proxy Support for details.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                v24.5.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                pskCallback?: (hint: string) => PSKCallbackNegotation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                When negotiating TLS-PSK (pre-shared keys), this function is called +with optional identity hint provided by the server or null +in case of TLS 1.3 where hint was removed. +It will be necessary to provide a custom tls.checkServerIdentity() +for the connection as the default one will try to check hostname/IP +of the server against the certificate but that's not applicable for PSK +because there won't be a certificate present. +More information can be found in the RFC 4279.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • (hint: string): PSKCallbackNegotation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • hint: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      message sent from the server to help client +decide which identity to use during negotiation. +Always null if TLS 1.3 is used.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns PSKCallbackNegotation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return null to stop the negotiation process. psk must be +compatible with the selected cipher's digest. +identity must use UTF-8 encoding.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                rejectUnauthorized?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                If true the server will reject any connection which is not authorized with the list of supplied CAs. This option only has an effect if requestCert is true.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                true
+
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                true
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                requestCert?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                If true the server will request a certificate from clients that +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                requestCert?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                If true the server will request a certificate from clients that connect and attempt to verify that certificate. Defaults to false.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                scheduling?: "fifo" | "lifo"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Scheduling strategy to apply when picking the next free socket to use.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                lifo

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                secureContext?: SecureContext

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                An optional TLS context object from tls.createSecureContext()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                secureOptions?: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Optionally affect the OpenSSL protocol behavior, which is not +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                scheduling?: "fifo" | "lifo"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Scheduling strategy to apply when picking the next free socket to use.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                lifo

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                secureContext?: SecureContext

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                An optional TLS context object from tls.createSecureContext()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                secureOptions?: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Optionally affect the OpenSSL protocol behavior, which is not usually necessary. This should be used carefully if at all! Value is a numeric bitmask of the SSL_OP_* options from OpenSSL Options

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                secureProtocol?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Legacy mechanism to select the TLS protocol version to use, it does +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                secureProtocol?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Legacy mechanism to select the TLS protocol version to use, it does not support independent control of the minimum and maximum version, and does not support limiting the protocol to TLSv1.3. Use minVersion and maxVersion instead. The possible values are listed as @@ -188,37 +221,23 @@ any TLS protocol version up to TLSv1.3. It is not recommended to use TLS versions less than 1.2, but it may be required for interoperability. Default: none, see minVersion.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                servername?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                session?: Buffer<ArrayBufferLike>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                sessionIdContext?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Opaque identifier used by servers to ensure session state is not +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                servername?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                session?: Buffer<ArrayBufferLike>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                sessionIdContext?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Opaque identifier used by servers to ensure session state is not shared between applications. Unused by clients.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                sessionTimeout?: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                The number of seconds after which a TLS session created by the +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                sessionTimeout?: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                The number of seconds after which a TLS session created by the server will no longer be resumable. See Session Resumption for more information. Default: 300.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                sigalgs?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Colon-separated list of supported signature algorithms. The list +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                sigalgs?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Colon-separated list of supported signature algorithms. The list can contain digest algorithms (SHA256, MD5 etc.), public key algorithms (RSA-PSS, ECDSA etc.), combination of both (e.g 'RSA+SHA384') or TLS v1.3 scheme names (e.g. rsa_pss_pss_sha512).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                SNICallback?: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    servername: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    cb: (err: Error, ctx?: SecureContext) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                SNICallback(servername, cb) A function that will be +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                SNICallback?: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    servername: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    cb: (err: Error, ctx?: SecureContext) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                SNICallback(servername, cb) A function that will be called if the client supports SNI TLS extension. Two arguments will be passed when called: servername and cb. SNICallback should invoke cb(null, ctx), where ctx is a SecureContext instance. (tls.createSecureContext(...) can be used to get a proper SecureContext.) If SNICallback wasn't provided the default callback with high-level API will be used (see below).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                socket?: Duplex
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ticketKeys?: Buffer<ArrayBufferLike>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                48-bytes of cryptographically strong pseudo-random data. +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                socket?: Duplex
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ticketKeys?: Buffer<ArrayBufferLike>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                48-bytes of cryptographically strong pseudo-random data. See Session Resumption for more information.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                timeout?: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Socket timeout in milliseconds. This will set the timeout after the socket is connected.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • When negotiating TLS-PSK (pre-shared keys), this function is called -with optional identity hint provided by the server or null -in case of TLS 1.3 where hint was removed. -It will be necessary to provide a custom tls.checkServerIdentity() -for the connection as the default one will try to check hostname/IP -of the server against the certificate but that's not applicable for PSK -because there won't be a certificate present. -More information can be found in the RFC 4279.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • hint: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    message sent from the server to help client -decide which identity to use during negotiation. -Always null if TLS 1.3 is used.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns PSKCallbackNegotation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return null to stop the negotiation process. psk must be -compatible with the selected cipher's digest. -identity must use UTF-8 encoding.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                timeout?: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Socket timeout in milliseconds. This will set the timeout after the socket is connected.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/interfaces/_internal_.AgentOptions.html b/docs/interfaces/_internal_.AgentOptions.html index abf5c428..5227d038 100644 --- a/docs/interfaces/_internal_.AgentOptions.html +++ b/docs/interfaces/_internal_.AgentOptions.html @@ -1,7 +1,8 @@ -AgentOptions | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Interface AgentOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Make all properties in T optional

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  interface AgentOptions {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      autoSelectFamily?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      autoSelectFamilyAttemptTimeout?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      blockList?: BlockList;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      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;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      scheduling?: "fifo" | "lifo";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      timeout?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  autoSelectFamily? +AgentOptions | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    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? +defaultPort? family? hints? host? @@ -16,17 +17,35 @@ maxTotalSockets? noDelay? port? +protocol? +proxyEnv? scheduling? timeout? -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    autoSelectFamily?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    v18.13.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    autoSelectFamilyAttemptTimeout?: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    v18.13.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    blockList?: BlockList
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    family?: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    hints?: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    host?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    keepAlive?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Keep sockets around in a pool to be used by other requests in the future. Default = false

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    keepAliveInitialDelay?: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    keepAliveMsecs?: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    When using HTTP KeepAlive, how often to send TCP KeepAlive packets over sockets being kept alive. Default = 1000. +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    agentKeepAliveTimeoutBuffer?: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Milliseconds to subtract from +the server-provided keep-alive: timeout=... hint when determining socket +expiration time. This buffer helps ensure the agent closes the socket +slightly before the server does, reducing the chance of sending a request +on a socket that’s about to be closed by the server.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    v24.7.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    1000
+
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    autoSelectFamily?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    v18.13.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    autoSelectFamilyAttemptTimeout?: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    v18.13.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    blockList?: BlockList
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    defaultPort?: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Default port to use when the port is not specified in requests.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    v24.5.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    family?: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    hints?: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    host?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    keepAlive?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Keep sockets around in a pool to be used by other requests in the future. Default = false

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    keepAliveInitialDelay?: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    keepAliveMsecs?: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    When using HTTP KeepAlive, how often to send TCP KeepAlive packets over sockets being kept alive. Default = 1000. Only relevant if keepAlive is set to true.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    localAddress?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    localPort?: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    lookup?: LookupFunction
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    maxFreeSockets?: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Maximum number of sockets to leave open in a free state. Only relevant if keepAlive is set to true. Default = 256.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    maxSockets?: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Maximum number of sockets to allow per host. Default for Node 0.10 is 5, default for Node 0.12 is Infinity

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    maxTotalSockets?: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Maximum number of sockets allowed for all hosts in total. Each request will use a new socket until the maximum is reached. Default: Infinity.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    noDelay?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    port?: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    scheduling?: "fifo" | "lifo"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Scheduling strategy to apply when picking the next free socket to use.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    lifo

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    timeout?: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Socket timeout in milliseconds. This will set the timeout after the socket is connected.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    localAddress?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    localPort?: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    lookup?: LookupFunction
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    maxFreeSockets?: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Maximum number of sockets to leave open in a free state. Only relevant if keepAlive is set to true. Default = 256.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    maxSockets?: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Maximum number of sockets to allow per host. Default for Node 0.10 is 5, default for Node 0.12 is Infinity

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    maxTotalSockets?: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Maximum number of sockets allowed for all hosts in total. Each request will use a new socket until the maximum is reached. Default: Infinity.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    noDelay?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    port?: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    protocol?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The protocol to use for the agent.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    v24.5.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    proxyEnv?: ProxyEnv

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Environment variables for proxy configuration. See +Built-in Proxy Support for details.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    v24.5.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    scheduling?: "fifo" | "lifo"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Scheduling strategy to apply when picking the next free socket to use.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    lifo

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    timeout?: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Socket timeout in milliseconds. This will set the timeout after the socket is connected.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/interfaces/_internal_.ArrayBufferView.html b/docs/interfaces/_internal_.ArrayBufferView.html index acfc36c3..dc4c0cac 100644 --- a/docs/interfaces/_internal_.ArrayBufferView.html +++ b/docs/interfaces/_internal_.ArrayBufferView.html @@ -2,6 +2,6 @@ byteLength byteOffset

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    buffer: TArrayBuffer

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The ArrayBuffer instance referenced by the array.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    byteLength: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The length in bytes of the array.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    byteOffset: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The offset in bytes of the array.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    byteLength: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The length in bytes of the array.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    byteOffset: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The offset in bytes of the array.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/interfaces/_internal_.ArrayIterator.html b/docs/interfaces/_internal_.ArrayIterator.html index da5a2097..a7d95337 100644 --- a/docs/interfaces/_internal_.ArrayIterator.html +++ b/docs/interfaces/_internal_.ArrayIterator.html @@ -1,6 +1,6 @@ -ArrayIterator | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      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.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        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? throw? -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Returns ArrayIterator<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • ...__namedParameters: [] | [unknown]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns IteratorResult<T, any>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Returns ArrayIterator<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • ...__namedParameters: [] | [unknown]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns IteratorResult<T, any>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Optionalvalue: any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns IteratorResult<T, any>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Optionale: any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns IteratorResult<T, any>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/interfaces/_internal_.AsyncGenerator.html b/docs/interfaces/_internal_.AsyncGenerator.html index d0e073c0..6dd38578 100644 --- a/docs/interfaces/_internal_.AsyncGenerator.html +++ b/docs/interfaces/_internal_.AsyncGenerator.html @@ -1,6 +1,6 @@ -AsyncGenerator | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          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.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            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 throw -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Returns PromiseLike<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Returns PromiseLike<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • ...__namedParameters: [] | [TNext]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns Promise<IteratorResult<T, TReturn>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/interfaces/_internal_.AsyncGeneratorFunction.html b/docs/interfaces/_internal_.AsyncGeneratorFunction.html index 414c12b8..018a155a 100644 --- a/docs/interfaces/_internal_.AsyncGeneratorFunction.html +++ b/docs/interfaces/_internal_.AsyncGeneratorFunction.html @@ -1,12 +1,12 @@ AsyncGeneratorFunction | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Interface AsyncGeneratorFunction

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              interface AsyncGeneratorFunction {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  new AsyncGeneratorFunction(...args: any[]): AsyncGenerator;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  length: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  name: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  prototype: AsyncGenerator;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  (...args: any[]): AsyncGenerator;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Creates a new AsyncGenerator object.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • ...args: any[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  A list of arguments the function accepts.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns AsyncGenerator

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              constructor +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns AsyncGenerator

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              constructor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              length name prototype

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Creates a new AsyncGenerator object.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • ...args: any[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  A list of arguments the function accepts.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns AsyncGenerator

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              length: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The length of the arguments.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              name: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns the name of the function.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              prototype: AsyncGenerator

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              A reference to the prototype.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Constructors
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns AsyncGenerator

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              length: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The length of the arguments.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              name: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns the name of the function.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              prototype: AsyncGenerator

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              A reference to the prototype.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Constructors
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/interfaces/_internal_.AsyncIterableIterator.html b/docs/interfaces/_internal_.AsyncIterableIterator.html index 86a7d443..55f1f064 100644 --- a/docs/interfaces/_internal_.AsyncIterableIterator.html +++ b/docs/interfaces/_internal_.AsyncIterableIterator.html @@ -1,6 +1,6 @@ AsyncIterableIterator | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                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? -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/interfaces/_internal_.AsyncIterator.html b/docs/interfaces/_internal_.AsyncIterator.html index 73b27bea..95f8ad83 100644 --- a/docs/interfaces/_internal_.AsyncIterator.html +++ b/docs/interfaces/_internal_.AsyncIterator.html @@ -1,4 +1,4 @@ -AsyncIterator | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  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.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    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
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/interfaces/_internal_.AsyncResourceOptions.html b/docs/interfaces/_internal_.AsyncResourceOptions.html index 47e84ef1..c98fc4ea 100644 --- a/docs/interfaces/_internal_.AsyncResourceOptions.html +++ b/docs/interfaces/_internal_.AsyncResourceOptions.html @@ -1,4 +1,4 @@ -AsyncResourceOptions | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Interface AsyncResourceOptions

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      requireManualDestroy? +AsyncResourceOptions | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        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_.AuthScheme.html b/docs/interfaces/_internal_.AuthScheme.html index f7c621e8..75b0ef5b 100644 --- a/docs/interfaces/_internal_.AuthScheme.html +++ b/docs/interfaces/_internal_.AuthScheme.html @@ -1,5 +1,5 @@ AuthScheme | ts-lambda-api - v2.5.2

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Interface AuthSchemeInternal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Authentication schemes represent a way that the service will authenticate the customer’s identity.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          interface AuthScheme {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              name: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              properties: Record<string, unknown>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              signingName: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              signingRegion: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              signingRegionSet?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              signingScope?: never;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          name +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          interface AuthScheme {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              name: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              properties: Record<string, unknown>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              signingName: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              signingRegion: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              signingRegionSet?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              signingScope?: never;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          name properties signingName signingRegion diff --git a/docs/interfaces/_internal_.AwsCredentialIdentity.html b/docs/interfaces/_internal_.AwsCredentialIdentity.html index 1ee68ece..cb2017a7 100644 --- a/docs/interfaces/_internal_.AwsCredentialIdentity.html +++ b/docs/interfaces/_internal_.AwsCredentialIdentity.html @@ -1,14 +1,14 @@ -AwsCredentialIdentity | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            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.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              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? secretAccessKey sessionToken?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              accessKeyId: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              AWS access key ID

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              accountId?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              AWS accountId.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              credentialScope?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              AWS credential scope for this set of credentials.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              expiration?: Date

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              secretAccessKey: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              AWS secret access key

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              sessionToken?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              A security or session token to use with these credentials. Usually +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              accountId?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              AWS accountId.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              credentialScope?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              AWS credential scope for this set of credentials.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              expiration?: Date

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              secretAccessKey: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              AWS secret access key

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              sessionToken?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              A security or session token to use with these credentials. Usually present for temporary credentials.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/interfaces/_internal_.AwsRegionExtensionConfiguration.html b/docs/interfaces/_internal_.AwsRegionExtensionConfiguration.html index 91e4f27a..c10f31d5 100644 --- a/docs/interfaces/_internal_.AwsRegionExtensionConfiguration.html +++ b/docs/interfaces/_internal_.AwsRegionExtensionConfiguration.html @@ -1,3 +1,3 @@ -AwsRegionExtensionConfiguration | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                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.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  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 c9cec810..4ed49c8e 100644 --- a/docs/interfaces/_internal_.AwsSdkSigV4AAuthInputConfig.html +++ b/docs/interfaces/_internal_.AwsSdkSigV4AAuthInputConfig.html @@ -1,4 +1,4 @@ -AwsSdkSigV4AAuthInputConfig | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Interface AwsSdkSigV4AAuthInputConfig

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    sigv4aSigningRegionSet? +AwsSdkSigV4AAuthInputConfig | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      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:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      @@ -9,4 +9,4 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • signingRegionSet given by endpoint resolution.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • the singular region of the SDK client.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/interfaces/_internal_.AwsSdkSigV4AuthInputConfig.html b/docs/interfaces/_internal_.AwsSdkSigV4AuthInputConfig.html index 26fc587e..7ea2821e 100644 --- a/docs/interfaces/_internal_.AwsSdkSigV4AuthInputConfig.html +++ b/docs/interfaces/_internal_.AwsSdkSigV4AuthInputConfig.html @@ -1,15 +1,15 @@ -AwsSdkSigV4AuthInputConfig | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        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.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          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? signingRegion? systemClockOffset?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          credentials?: AwsCredentialIdentity | AwsCredentialIdentityProvider

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The credentials used to sign requests.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          signer?: RequestSigner | ((authScheme?: AuthScheme) => Promise<RequestSigner>)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The signer to use when signing requests.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          signerConstructor?: new (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              options: SignatureV4Init & SignatureV4CryptoInit,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ) => RequestSigner

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The injectable SigV4-compatible signer class constructor. If not supplied, +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          signer?: RequestSigner | ((authScheme?: AuthScheme) => Promise<RequestSigner>)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The signer to use when signing requests.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          signerConstructor?: new (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              options: SignatureV4Init & SignatureV4CryptoInit,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ) => RequestSigner

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The injectable SigV4-compatible signer class constructor. If not supplied, regular SignatureV4 constructor will be used.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          signingEscapePath?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Whether to escape request path when signing the request.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          signingRegion?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The region where you want to sign your request against. This +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          signingEscapePath?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Whether to escape request path when signing the request.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          signingRegion?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The region where you want to sign your request against. This can be different to the region in the endpoint.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          systemClockOffset?: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          An offset value in milliseconds to apply to all signing times.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          systemClockOffset?: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          An offset value in milliseconds to apply to all signing times.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/interfaces/_internal_.BaseMultipleResolvedValueMetadataInjectOptions.html b/docs/interfaces/_internal_.BaseMultipleResolvedValueMetadataInjectOptions.html index 3644965e..1a838d02 100644 --- a/docs/interfaces/_internal_.BaseMultipleResolvedValueMetadataInjectOptions.html +++ b/docs/interfaces/_internal_.BaseMultipleResolvedValueMetadataInjectOptions.html @@ -1,3 +1,3 @@ -BaseMultipleResolvedValueMetadataInjectOptions | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Interface BaseMultipleResolvedValueMetadataInjectOptions

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            chained? +BaseMultipleResolvedValueMetadataInjectOptions | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              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 06db4c55..eaf31ae5 100644 --- a/docs/interfaces/_internal_.BaseOperation.html +++ b/docs/interfaces/_internal_.BaseOperation.html @@ -1,2 +1,2 @@ -BaseOperation | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Interface BaseOperation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                interface BaseOperation {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    path: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                path +BaseOperation | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  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 23d0bdd5..b638cb94 100644 --- a/docs/interfaces/_internal_.BaseOptionalResolvedValueMetadataInjectOptions.html +++ b/docs/interfaces/_internal_.BaseOptionalResolvedValueMetadataInjectOptions.html @@ -1,2 +1,2 @@ -BaseOptionalResolvedValueMetadataInjectOptions | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Interface BaseOptionalResolvedValueMetadataInjectOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    interface BaseOptionalResolvedValueMetadataInjectOptions {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        optional: true;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    optional +BaseOptionalResolvedValueMetadataInjectOptions | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      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 83043fe2..a17f903f 100644 --- a/docs/interfaces/_internal_.BaseParameterObject.html +++ b/docs/interfaces/_internal_.BaseParameterObject.html @@ -1,4 +1,4 @@ -BaseParameterObject | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        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.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          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 fcef97d0..4761652c 100644 --- a/docs/interfaces/_internal_.BaseResolvedValueMetadataInjectOptions.html +++ b/docs/interfaces/_internal_.BaseResolvedValueMetadataInjectOptions.html @@ -1,4 +1,4 @@ -BaseResolvedValueMetadataInjectOptions | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            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.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              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 067ef045..7c905e69 100644 --- a/docs/interfaces/_internal_.BindInFluentSyntax.html +++ b/docs/interfaces/_internal_.BindInFluentSyntax.html @@ -1,5 +1,5 @@ -BindInFluentSyntax | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                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.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  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 -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/interfaces/_internal_.BindInWhenOnFluentSyntax.html b/docs/interfaces/_internal_.BindInWhenOnFluentSyntax.html index d1adbad0..37047aec 100644 --- a/docs/interfaces/_internal_.BindInWhenOnFluentSyntax.html +++ b/docs/interfaces/_internal_.BindInWhenOnFluentSyntax.html @@ -1,4 +1,4 @@ -BindInWhenOnFluentSyntax | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    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.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      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 @@ -24,4 +24,4 @@ whenParentNamed whenParentTagged whenTagged -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/interfaces/_internal_.BindOnFluentSyntax.html b/docs/interfaces/_internal_.BindOnFluentSyntax.html index 3a5bba85..ca8f942a 100644 --- a/docs/interfaces/_internal_.BindOnFluentSyntax.html +++ b/docs/interfaces/_internal_.BindOnFluentSyntax.html @@ -1,4 +1,4 @@ -BindOnFluentSyntax | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        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.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          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
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/interfaces/_internal_.BindToFluentSyntax.html b/docs/interfaces/_internal_.BindToFluentSyntax.html index eccdb059..028cc65a 100644 --- a/docs/interfaces/_internal_.BindToFluentSyntax.html +++ b/docs/interfaces/_internal_.BindToFluentSyntax.html @@ -1,9 +1,12 @@ -BindToFluentSyntax | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Interface BindToFluentSyntax<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            interface BindToFluentSyntax<T> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                to(type: Newable<T>): BindInWhenOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                toConstantValue(value: T): BindWhenOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                toDynamicValue(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    builder: DynamicValueBuilder<T>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): BindInWhenOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                toFactory(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    factory: T extends Factory<unknown, any>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ? (context: ResolutionContext) => T<T>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        : never,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): BindWhenOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                toProvider(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    provider: T extends Provider<unknown, any>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ? (context: ResolutionContext) => T<T>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        : never,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): BindWhenOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                toResolvedValue(factory: () => T): BindInWhenOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                toResolvedValue<TArgs extends unknown[] = any[]>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    factory: (...args: TArgs) => T,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    injectOptions: MapToResolvedValueInjectOptions<TArgs>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): BindInWhenOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                toSelf(): BindInWhenOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                toService(service: ServiceIdentifier<T>): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • T
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            to +BindToFluentSyntax | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Interface BindToFluentSyntax<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              interface BindToFluentSyntax<T> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  to(type: Newable<T>): BindInWhenOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  toConstantValue(value: T): BindWhenOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  toDynamicValue(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      builder: DynamicValueBuilder<T>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ): BindInWhenOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  toFactory(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      factory: T extends Factory<unknown, any>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ? (context: ResolutionContext) => T<T> | Promise<T<T>>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          : never,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ): BindWhenOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  toProvider(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      provider: T extends Provider<unknown, any>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ? (context: ResolutionContext) => T<T>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          : never,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ): BindWhenOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  toResolvedValue(factory: () => T | Promise<T>): BindInWhenOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  toResolvedValue<TArgs extends unknown[] = any[]>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      factory: (...args: TArgs) => T | Promise<T>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      injectOptions: MapToResolvedValueInjectOptions<TArgs>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ): BindInWhenOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  toSelf(): BindInWhenOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  toService(service: ServiceIdentifier<T>): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • T
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              to toConstantValue toDynamicValue toFactory -toProvider +toProvider toResolvedValue toSelf toService -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns BindWhenOnFluentSyntax<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Use toFactory() instead. Providers will be removed in v8. +Providers exist for historical reasons from v5 when async dependencies weren't supported. +Factories are more flexible and can handle both sync and async operations.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/interfaces/_internal_.BindWhenFluentSyntax.html b/docs/interfaces/_internal_.BindWhenFluentSyntax.html index 2db5aed7..6c054264 100644 --- a/docs/interfaces/_internal_.BindWhenFluentSyntax.html +++ b/docs/interfaces/_internal_.BindWhenFluentSyntax.html @@ -1,4 +1,4 @@ -BindWhenFluentSyntax | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                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.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  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 @@ -19,4 +19,4 @@ whenParentNamed whenParentTagged whenTagged -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/interfaces/_internal_.BindWhenOnFluentSyntax.html b/docs/interfaces/_internal_.BindWhenOnFluentSyntax.html index b14b1f0b..22cbbb6e 100644 --- a/docs/interfaces/_internal_.BindWhenOnFluentSyntax.html +++ b/docs/interfaces/_internal_.BindWhenOnFluentSyntax.html @@ -1,4 +1,4 @@ -BindWhenOnFluentSyntax | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    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.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      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 @@ -21,4 +21,4 @@ whenParentNamed whenParentTagged whenTagged -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/interfaces/_internal_.BlobOptions.html b/docs/interfaces/_internal_.BlobOptions.html index 7eb2eead..5f4317ce 100644 --- a/docs/interfaces/_internal_.BlobOptions.html +++ b/docs/interfaces/_internal_.BlobOptions.html @@ -1,8 +1,8 @@ -BlobOptions | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Interface BlobOptionsExperimental

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        interface BlobOptions {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            endings?: "transparent" | "native";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            type?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        endings? +BlobOptions | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Interface BlobOptionsExperimental

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          interface BlobOptions {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              endings?: "transparent" | "native";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              type?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          endings? type?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          endings?: "transparent" | "native"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          One of either 'transparent' or 'native'. When set to 'native', line endings in string source parts will be converted to the platform native line-ending as specified by import { EOL } from 'node:os'.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          type?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The Blob content-type. The intent is for type to convey +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          type?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The Blob content-type. The intent is for type to convey the MIME media type of the data, however no validation of the type format is performed.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/interfaces/_internal_.BoundServiceSyntax.html b/docs/interfaces/_internal_.BoundServiceSyntax.html index 595b12fd..f8d09c8e 100644 --- a/docs/interfaces/_internal_.BoundServiceSyntax.html +++ b/docs/interfaces/_internal_.BoundServiceSyntax.html @@ -1,2 +1,2 @@ -BoundServiceSyntax | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Interface BoundServiceSyntax

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            interface BoundServiceSyntax {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                getIdentifier(): BindingIdentifier;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            getIdentifier +BoundServiceSyntax | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              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_.CallSite.html b/docs/interfaces/_internal_.CallSite.html index a91a7e59..c1233adc 100644 --- a/docs/interfaces/_internal_.CallSite.html +++ b/docs/interfaces/_internal_.CallSite.html @@ -1,4 +1,4 @@ -CallSite | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Interface CallSite

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                interface CallSite {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    getColumnNumber(): number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    getEnclosingColumnNumber(): number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    getEnclosingLineNumber(): number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    getEvalOrigin(): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    getFileName(): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    getFunction(): Function;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    getFunctionName(): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    getLineNumber(): number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    getMethodName(): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    getPosition(): number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    getPromiseIndex(): number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    getScriptHash(): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    getScriptNameOrSourceURL(): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    getThis(): unknown;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    getTypeName(): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    isAsync(): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    isConstructor(): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    isEval(): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    isNative(): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    isPromiseAll(): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    isToplevel(): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                getColumnNumber +CallSite | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Interface CallSite

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  interface CallSite {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      getColumnNumber(): number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      getEnclosingColumnNumber(): number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      getEnclosingLineNumber(): number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      getEvalOrigin(): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      getFileName(): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      getFunction(): Function;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      getFunctionName(): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      getLineNumber(): number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      getMethodName(): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      getPosition(): number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      getPromiseIndex(): number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      getScriptHash(): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      getScriptNameOrSourceURL(): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      getThis(): unknown;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      getTypeName(): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      isAsync(): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      isConstructor(): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      isEval(): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      isNative(): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      isPromiseAll(): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      isToplevel(): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  getColumnNumber getEnclosingColumnNumber getEnclosingLineNumber getEvalOrigin @@ -19,4 +19,4 @@ isNative isPromiseAll isToplevel -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Returns number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Returns number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Returns number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Returns string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Returns string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Returns Function

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Returns string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Returns number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Returns string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Returns number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Returns number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Returns string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Returns string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Returns unknown

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Returns string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Returns number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Returns number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Returns number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Returns string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Returns string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Returns Function

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Returns string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Returns number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Returns string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Returns number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Returns number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Returns string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Returns string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Returns unknown

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Returns string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/interfaces/_internal_.CallbackObject.html b/docs/interfaces/_internal_.CallbackObject.html index f3d09647..e9c45c20 100644 --- a/docs/interfaces/_internal_.CallbackObject.html +++ b/docs/interfaces/_internal_.CallbackObject.html @@ -1 +1 @@ -CallbackObject | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    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.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      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 e25fb1d5..2df210bd 100644 --- a/docs/interfaces/_internal_.CallbacksObject.html +++ b/docs/interfaces/_internal_.CallbacksObject.html @@ -1 +1 @@ -CallbacksObject | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        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.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          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 4166ab81..b809e219 100644 --- a/docs/interfaces/_internal_.Certificate.html +++ b/docs/interfaces/_internal_.Certificate.html @@ -1,13 +1,13 @@ -Certificate | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Interface Certificate

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            interface Certificate {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                C: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                CN: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                L: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                O: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                OU: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ST: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            C +Certificate | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Interface Certificate

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              interface Certificate {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  C: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  CN: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  L: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  O: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  OU: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ST: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              C CN L O OU ST

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              C: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Country code.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              CN: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Common name.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              L: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Locality.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              O: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Organization.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              OU: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Organizational unit.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ST: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Street.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              CN: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Common name.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              L: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Locality.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              O: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Organization.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              OU: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Organizational unit.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ST: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Street.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/interfaces/_internal_.Checksum.html b/docs/interfaces/_internal_.Checksum.html index 69c5d18e..5cbaa787 100644 --- a/docs/interfaces/_internal_.Checksum.html +++ b/docs/interfaces/_internal_.Checksum.html @@ -7,24 +7,24 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              A class that implements this interface may accept an optional secret key in its constructor while computing checksum value, when using HMAC. If provided, this secret key would be used when computing checksum.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              interface Checksum {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  digestLength?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  copy(): Checksum;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  digest(): Promise<Uint8Array<ArrayBufferLike>>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  mark(readLimit: number): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  reset(): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  update(chunk: Uint8Array): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              digestLength? +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              interface Checksum {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  digestLength?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  copy?(): Checksum;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  digest(): Promise<Uint8Array<ArrayBufferLike>>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  mark?(readLimit: number): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  reset(): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  update(chunk: Uint8Array): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              digestLength?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              copy? digest mark? reset update

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              digestLength?: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Constant length of the digest created by the algorithm in bytes.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Creates a new checksum object that contains a deep copy of the internal +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Creates a new checksum object that contains a deep copy of the internal state of the current Checksum object.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns Checksum

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Returns the digest of all of the data passed.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns Promise<Uint8Array<ArrayBufferLike>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Allows marking a checksum for checksums that support the ability +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns Checksum

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Returns the digest of all of the data passed.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns Promise<Uint8Array<ArrayBufferLike>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Allows marking a checksum for checksums that support the ability to mark and reset.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • readLimit: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The maximum limit of bytes that can be read before the mark position becomes invalid.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Resets the checksum to its initial value.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Adds a chunk of data for which checksum needs to be computed. +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Resets the checksum to its initial value.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Adds a chunk of data for which checksum needs to be computed. This can be called many times with new data as it is streamed.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Implementations may override this method which passes second param which makes Checksum object stateless.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • chunk: Uint8Array

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The buffer to update checksum with.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/interfaces/_internal_.ChecksumConfiguration.html b/docs/interfaces/_internal_.ChecksumConfiguration.html index 5685abf1..f9b085d8 100644 --- a/docs/interfaces/_internal_.ChecksumConfiguration.html +++ b/docs/interfaces/_internal_.ChecksumConfiguration.html @@ -1,3 +1,3 @@ -ChecksumConfiguration | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                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.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  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_.ChecksumConstructor.html b/docs/interfaces/_internal_.ChecksumConstructor.html index d3430c48..33067c15 100644 --- a/docs/interfaces/_internal_.ChecksumConstructor.html +++ b/docs/interfaces/_internal_.ChecksumConstructor.html @@ -1,5 +1,5 @@ ChecksumConstructor | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Interface ChecksumConstructor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    A constructor for a Checksum that may be used to calculate an HMAC. Implementing classes should not directly hold the provided key in memory beyond the lexical scope of the constructor.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    interface ChecksumConstructor {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        new ChecksumConstructor(secret?: SourceData): Checksum;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    constructor +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    interface ChecksumConstructor {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        new ChecksumConstructor(secret?: SourceData): Checksum;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    constructor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Constructors
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/interfaces/_internal_.ClientDefaults.html b/docs/interfaces/_internal_.ClientDefaults.html index 4b69ea78..39513586 100644 --- a/docs/interfaces/_internal_.ClientDefaults.html +++ b/docs/interfaces/_internal_.ClientDefaults.html @@ -1,4 +1,4 @@ -ClientDefaults | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      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;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          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.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Interface ClientDefaults

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        apiVersion? base64Decoder? base64Encoder? bodyLengthChecker? @@ -14,6 +14,7 @@ maxAttempts? md5? profile? +protocol? region? requestHandler? retryMode? @@ -33,10 +34,10 @@ utf8Encoder?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        apiVersion?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The API version set internally by the SDK, and is not planned to be used by customer code.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        base64Decoder?: Decoder

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The function that will be used to convert a base64-encoded string to a byte array.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        base64Encoder?: Encoder

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The function that will be used to convert binary data to a base64-encoded string.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        bodyLengthChecker?: BodyLengthCalculator

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        A function that can calculate the length of a request body.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        cacheMiddleware?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Default false.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        base64Decoder?: Decoder

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The function that will be used to convert a base64-encoded string to a byte array.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        base64Encoder?: Encoder

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The function that will be used to convert binary data to a base64-encoded string.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        bodyLengthChecker?: BodyLengthCalculator

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        A function that can calculate the length of a request body.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        cacheMiddleware?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Default false.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        When true, the client will only resolve the middleware stack once per Command class. This means modifying the middlewareStack of the command or client after requests have been made will not be @@ -44,19 +45,19 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Calling client.destroy() also clears this cache.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Enable this only if needing the additional time saved (0-1ms per request) and not needing middleware modifications between requests.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        credentialDefaultProvider?: (input: any) => AwsCredentialIdentityProvider

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Default credentials provider; Not available in browser runtime.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        defaultsMode?: DefaultsMode | Provider<DefaultsMode>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        defaultUserAgentProvider?: Provider<UserAgent>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The provider populating default tracking information to be sent with user-agent, x-amz-user-agent header

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        disableHostPrefix?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Disable dynamically changing the endpoint of the client based on the hostPrefix +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        credentialDefaultProvider?: (input: any) => AwsCredentialIdentityProvider

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Default credentials provider; Not available in browser runtime.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        defaultsMode?: DefaultsMode | Provider<DefaultsMode>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        defaultUserAgentProvider?: Provider<UserAgent>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The provider populating default tracking information to be sent with user-agent, x-amz-user-agent header

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        disableHostPrefix?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        eventStreamSerdeProvider?: EventStreamSerdeProvider

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The function that provides necessary utilities for generating and parsing event stream

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        extensions?: RuntimeExtension[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Optional extensions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        getAwsChunkedEncodingStream?: GetAwsChunkedEncodingStream

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        A function that returns Readable Stream which follows aws-chunked encoding stream.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        logger?: Logger

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Optional logger for logging debug/info/warn/error.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        maxAttempts?: number | Provider<number>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Value for how many times a request will be made at most in case of retry.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        md5?: HashConstructor | ChecksumConstructor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        A constructor for a class implementing the __Checksum interface +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        eventStreamSerdeProvider?: EventStreamSerdeProvider

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The function that provides necessary utilities for generating and parsing event stream

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        extensions?: RuntimeExtension[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Optional extensions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        getAwsChunkedEncodingStream?: GetAwsChunkedEncodingStream

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        A function that returns Readable Stream which follows aws-chunked encoding stream.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        logger?: Logger

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Optional logger for logging debug/info/warn/error.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        maxAttempts?: number | Provider<number>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Value for how many times a request will be made at most in case of retry.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        md5?: HashConstructor | ChecksumConstructor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        A constructor for a class implementing the __Checksum interface that computes MD5 hashes.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        profile?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Setting a client profile is similar to setting a value for the +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        profile?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        When set, and only for environments where an AWS configuration @@ -68,25 +69,29 @@ configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        region?: string | Provider<string>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The AWS region to which this client will send requests

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        requestHandler?: HttpHandlerUserInput

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        retryMode?: string | Provider<string>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Specifies which retry algorithm to use.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        protocol?: ClientProtocol<HttpRequest, HttpResponse>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The protocol controlling the message type (e.g. HTTP) and format (e.g. JSON) +may be overridden. A default will always be set by the client. +Available options depend on the service's supported protocols and will not be validated by +the client.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        region?: string | Provider<string>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The AWS region to which this client will send requests

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        requestHandler?: HttpHandlerUserInput

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        retryMode?: string | Provider<string>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Specifies which retry algorithm to use.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-smithy-util-retry/Enum/RETRY_MODES/

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        runtime?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The runtime environment.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        sdkStreamMixin?: SdkStreamMixinInjector

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The internal function that inject utilities to runtime-specific stream to help users consume the data

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        serviceId?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Unique service identifier.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        sha1?: HashConstructor | ChecksumConstructor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        A constructor for a class implementing the __Checksum interface +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        runtime?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The runtime environment.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        sdkStreamMixin?: SdkStreamMixinInjector

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The internal function that inject utilities to runtime-specific stream to help users consume the data

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        serviceId?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Unique service identifier.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        sha1?: HashConstructor | ChecksumConstructor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        A constructor for a class implementing the __Checksum interface that computes SHA1 hashes.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        sha256?: HashConstructor | ChecksumConstructor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        A constructor for a class implementing the @smithy/types#ChecksumConstructor interface +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        sha256?: HashConstructor | ChecksumConstructor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        A constructor for a class implementing the @smithy/types#ChecksumConstructor interface that computes the SHA-256 HMAC or checksum of a string or binary buffer.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        signingEscapePath?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Whether to escape request path when signing the request.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        streamCollector?: StreamCollector

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        A function that converts a stream into an array of bytes.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        streamHasher?: StreamHasher<Readable> | StreamHasher<Blob>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        A function that, given a hash constructor and a stream, calculates the +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        signingEscapePath?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Whether to escape request path when signing the request.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        streamCollector?: StreamCollector

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        A function that converts a stream into an array of bytes.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        streamHasher?: StreamHasher<Readable> | StreamHasher<Blob>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        A function that, given a hash constructor and a stream, calculates the hash of the streamed value.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        urlParser?: UrlParser

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The function that will be used to convert strings into HTTP endpoints.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        useArnRegion?: boolean | Provider<boolean>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Whether to override the request region with the region inferred from requested resource's ARN. Defaults to undefined.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        useDualstackEndpoint?: boolean | Provider<boolean>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Enables IPv6/IPv4 dualstack endpoint.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        useFipsEndpoint?: boolean | Provider<boolean>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Enables FIPS compatible endpoints.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        utf8Decoder?: Decoder

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The function that will be used to convert a UTF8-encoded string to a byte array.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        utf8Encoder?: Encoder

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The function that will be used to convert binary data to a UTF-8 encoded string.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        urlParser?: UrlParser

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The function that will be used to convert strings into HTTP endpoints.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        useArnRegion?: boolean | Provider<boolean>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Whether to override the request region with the region inferred from requested resource's ARN. Defaults to undefined.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        useDualstackEndpoint?: boolean | Provider<boolean>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Enables IPv6/IPv4 dualstack endpoint.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        useFipsEndpoint?: boolean | Provider<boolean>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Enables FIPS compatible endpoints.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        utf8Decoder?: Decoder

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The function that will be used to convert a UTF8-encoded string to a byte array.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        utf8Encoder?: Encoder

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The function that will be used to convert binary data to a UTF-8 encoded string.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/interfaces/_internal_.ClientProtocol.html b/docs/interfaces/_internal_.ClientProtocol.html new file mode 100644 index 00000000..a234aaf8 --- /dev/null +++ b/docs/interfaces/_internal_.ClientProtocol.html @@ -0,0 +1,14 @@ +ClientProtocol | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          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 +getPayloadCodec +getRequestType +getResponseType +getShapeId +serializeRequest +setSerdeContext +updateServiceEndpoint +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Returns Codec<any, any>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            the payload codec if the requests/responses have a symmetric format. +It otherwise may return null.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Returns new (...args: any[]) => Request

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Returns new (...args: any[]) => Response

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Returns string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            the Smithy qualified shape id.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/interfaces/_internal_.ClientRequestArgs.html b/docs/interfaces/_internal_.ClientRequestArgs.html index f7d3df52..7e758eb2 100644 --- a/docs/interfaces/_internal_.ClientRequestArgs.html +++ b/docs/interfaces/_internal_.ClientRequestArgs.html @@ -1,11 +1,12 @@ -ClientRequestArgs | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Interface ClientRequestArgs

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            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[])[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            _defaultAgent? +ClientRequestArgs | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              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? agent? auth? createConnection? defaultPort? family? headers? -hints? +hints? host? hostname? insecureHTTPParser? @@ -24,7 +25,9 @@ socketPath? timeout? uniqueHeaders? -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Optional_defaultAgent

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              _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
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              16384
+

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Optional_defaultAgent

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              _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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              One or more supported getaddrinfo flags. Multiple flags may be +passed by bitwise ORing their values.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              host?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              hostname?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              insecureHTTPParser?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              joinDuplicateHeaders?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              localAddress?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              localPort?: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              lookup?: LookupFunction
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              maxHeaderSize?: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              16384
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              method?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              path?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              port?: string | number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              protocol?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              setDefaultHeaders?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              setHost?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              signal?: AbortSignal
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              socketPath?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              timeout?: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              uniqueHeaders?: (string | string[])[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              method?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              path?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              port?: string | number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              protocol?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              setDefaultHeaders?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              setHost?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              signal?: AbortSignal
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              socketPath?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              timeout?: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              uniqueHeaders?: (string | string[])[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/interfaces/_internal_.Codec.html b/docs/interfaces/_internal_.Codec.html new file mode 100644 index 00000000..e0fdd763 --- /dev/null +++ b/docs/interfaces/_internal_.Codec.html @@ -0,0 +1,6 @@ +Codec | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                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 +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 e8d8b634..8b65cc1a 100644 --- a/docs/interfaces/_internal_.CollectionTag.html +++ b/docs/interfaces/_internal_.CollectionTag.html @@ -1,4 +1,4 @@ -CollectionTag | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  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.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    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? @@ -9,24 +9,24 @@ tag test?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    collection: "map" | "seq"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The source collection type supported by this tag.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    createNode?: (schema: Schema, value: unknown, ctx: CreateNodeContext) => Node

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    An optional factory function, used e.g. by collections when wrapping JS objects as AST nodes.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    default?: boolean | "key"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    If true, allows for values to be stringified without +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    createNode?: (schema: Schema, value: unknown, ctx: CreateNodeContext) => Node

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    An optional factory function, used e.g. by collections when wrapping JS objects as AST nodes.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    default?: boolean | "key"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    If true, allows for values to be stringified without an explicit tag together with test. If 'key', this only applies if the value is used as a mapping key. For most cases, it's unlikely that you'll actually want to use this, even if you first think you do.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    format?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    If a tag has multiple forms that should be parsed and/or stringified +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    format?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    If a tag has multiple forms that should be parsed and/or stringified differently, use format to identify them.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    identify?: (value: unknown) => boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Used by YAML.createNode to detect your data type, e.g. using typeof or +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    identify?: (value: unknown) => boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Used by YAML.createNode to detect your data type, e.g. using typeof or instanceof.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    nodeClass?: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        from?: (schema: Schema, obj: unknown, ctx: CreateNodeContext) => Node;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        new (schema?: Schema): Node;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The Node child class that implements this tag. +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    nodeClass?: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        from?: (schema: Schema, obj: unknown, ctx: CreateNodeContext) => Node;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        new (schema?: Schema): Node;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The Node child class that implements this tag. If set, used to select this tag when stringifying.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    If the class provides a static from method, then that will be used if the tag object doesn't have a createNode method.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    resolve?: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        value: Parsed<ParsedNode, ParsedNode> | Parsed<ParsedNode>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        onError: (message: string) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        options: ParseOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ) => unknown

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Turns a value into an AST node. +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    resolve?: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        value: Parsed<ParsedNode, ParsedNode> | Parsed<ParsedNode>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        onError: (message: string) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        options: ParseOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ) => unknown

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Turns a value into an AST node. If returning a non-Node value, the output will be wrapped as a Scalar.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Note: this is required if nodeClass is not provided.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    stringify?: never
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    tag: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The identifier for your data type, with which its stringified form will be +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    stringify?: never
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    tag: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The identifier for your data type, with which its stringified form will be prefixed. Should either be a !-prefixed local !tag, or a fully qualified tag:domain,date:foo.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    test?: never

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    test?: never

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/interfaces/_internal_.CommonConnectionOptions.html b/docs/interfaces/_internal_.CommonConnectionOptions.html index 13667736..6e979f90 100644 --- a/docs/interfaces/_internal_.CommonConnectionOptions.html +++ b/docs/interfaces/_internal_.CommonConnectionOptions.html @@ -1,31 +1,31 @@ -CommonConnectionOptions | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Interface CommonConnectionOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      interface CommonConnectionOptions {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ALPNProtocols?:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | string[]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | Uint8Array<ArrayBufferLike>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | Uint8Array<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.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        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? secureContext? SNICallback? -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ALPNProtocols?:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | string[]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | Uint8Array<ArrayBufferLike>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | Uint8Array<ArrayBufferLike>[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        An array of strings or a Buffer naming possible ALPN protocols. +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ALPNProtocols?: readonly string[] | ArrayBufferView<ArrayBufferLike>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        An array of strings or a Buffer naming possible ALPN protocols. (Protocols should be ordered by their priority.)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        enableTrace?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        When enabled, TLS packet trace information is written to stderr. This can be +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        enableTrace?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        When enabled, TLS packet trace information is written to stderr. This can be used to debug TLS connection problems.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        rejectUnauthorized?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        If true the server will reject any connection which is not +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        rejectUnauthorized?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        If true the server will reject any connection which is not authorized with the list of supplied CAs. This option only has an effect if requestCert is true.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        true
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        requestCert?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        If true the server will request a certificate from clients that +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        requestCert?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        If true the server will request a certificate from clients that connect and attempt to verify that certificate. Defaults to false.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        secureContext?: SecureContext

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        An optional TLS context object from tls.createSecureContext()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        SNICallback?: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            servername: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            cb: (err: Error, ctx?: SecureContext) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        SNICallback(servername, cb) A function that will be +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        secureContext?: SecureContext

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        An optional TLS context object from tls.createSecureContext()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        SNICallback?: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            servername: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            cb: (err: Error, ctx?: SecureContext) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        SNICallback(servername, cb) A function that will be called if the client supports SNI TLS extension. Two arguments will be passed when called: servername and cb. SNICallback should invoke cb(null, ctx), where ctx is a SecureContext instance. (tls.createSecureContext(...) can be used to get a proper SecureContext.) If SNICallback wasn't provided the default callback with high-level API will be used (see below).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/interfaces/_internal_.ComponentsObject.html b/docs/interfaces/_internal_.ComponentsObject.html index 767d678f..ee3f46c8 100644 --- a/docs/interfaces/_internal_.ComponentsObject.html +++ b/docs/interfaces/_internal_.ComponentsObject.html @@ -1,4 +1,4 @@ -ComponentsObject | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          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.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            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 new file mode 100644 index 00000000..e08ad14d --- /dev/null +++ b/docs/interfaces/_internal_.ConfigurableSerdeContext.html @@ -0,0 +1,4 @@ +ConfigurableSerdeContext | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              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 +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              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 13e52d07..bf6efc4a 100644 --- a/docs/interfaces/_internal_.ConnectionOptions.html +++ b/docs/interfaces/_internal_.ConnectionOptions.html @@ -1,4 +1,4 @@ -ConnectionOptions | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Interface ConnectionOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                interface ConnectionOptions {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    allowPartialTrustChain?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ALPNCallback?: (arg: { protocols: string[]; servername: string }) => string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ALPNProtocols?:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | string[]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | Uint8Array<ArrayBufferLike>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | Uint8Array<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;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    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;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    pskCallback(hint: string): PSKCallbackNegotation;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                allowPartialTrustChain? +ConnectionOptions | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  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? @@ -23,6 +23,7 @@ port? privateKeyEngine? privateKeyIdentifier? +pskCallback? rejectUnauthorized? requestCert? secureContext? @@ -37,11 +38,10 @@ socket? ticketKeys? timeout? -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  pskCallback?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  allowPartialTrustChain?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Treat intermediate (non-self-signed) certificates in the trust CA certificate list as trusted.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  v22.9.0, v20.18.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ALPNCallback?: (arg: { protocols: string[]; servername: string }) => string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  If set, this will be called when a client opens a connection using the ALPN extension. +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ALPNCallback?: (arg: { protocols: string[]; servername: string }) => string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  If set, this will be called when a client opens a connection using the ALPN extension. One argument will be passed to the callback: an object containing servername and protocols fields, respectively containing the server name from the SNI extension (if any) and an array of ALPN protocol name strings. The callback must return either one of the strings listed in protocols, @@ -49,12 +49,12 @@ to reject the connection with a fatal alert. If a string is returned that does not match one of the client's ALPN protocols, an error will be thrown. This option cannot be used with the ALPNProtocols option, and setting both options will throw an error.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ALPNProtocols?:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | string[]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | Uint8Array<ArrayBufferLike>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | Uint8Array<ArrayBufferLike>[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  An array of strings or a Buffer naming possible ALPN protocols. +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ALPNProtocols?: readonly string[] | ArrayBufferView<ArrayBufferLike>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  An array of strings or a Buffer naming possible ALPN protocols. (Protocols should be ordered by their priority.)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ca?: string | Buffer<ArrayBufferLike> | (string | Buffer<ArrayBufferLike>)[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Optionally override the trusted CA certificates. Default is to trust +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ca?: string | Buffer<ArrayBufferLike> | (string | Buffer<ArrayBufferLike>)[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Optionally override the trusted CA certificates. Default is to trust the well-known CAs curated by Mozilla. Mozilla's CAs are completely replaced when CAs are explicitly specified using this option.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  cert?: string | Buffer<ArrayBufferLike> | (string | Buffer<ArrayBufferLike>)[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Cert chains in PEM format. One cert chain should be provided per +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  cert?: string | Buffer<ArrayBufferLike> | (string | Buffer<ArrayBufferLike>)[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Cert chains in PEM format. One cert chain should be provided per private key. Each cert chain should consist of the PEM formatted certificate for a provided private key, followed by the PEM formatted intermediate certificates (if any), in order, and not @@ -63,7 +63,7 @@ be in the same order as their private keys in key. If the intermediate certificates are not provided, the peer will not be able to validate the certificate, and the handshake will fail.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  checkServerIdentity?: (hostname: string, cert: PeerCertificate) => Error

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  checkServerIdentity?: (hostname: string, cert: PeerCertificate) => Error

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • (hostname: string, cert: PeerCertificate): Error

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Verifies the certificate cert is issued to hostname.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns Error object, populating it with reason, host, and cert on failure. On success, returns undefined.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      This function is intended to be used in combination with thecheckServerIdentity option that can be passed to connect and as @@ -77,33 +77,33 @@ was present (see CVE-2021-44531). Applications that wish to acceptuniformResourceIdentifier subject alternative names can use a custom options.checkServerIdentity function that implements the desired behavior.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • hostname: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The host name or IP address to verify the certificate against.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • cert: PeerCertificate

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        A certificate object representing the peer's certificate.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns Error

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      v0.8.4

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ciphers?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Cipher suite specification, replacing the default. For more +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • cert: PeerCertificate

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  A certificate object representing the peer's certificate.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Returns Error

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  v0.8.4

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ciphers?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Cipher suite specification, replacing the default. For more information, see modifying the default cipher suite. Permitted ciphers can be obtained via tls.getCiphers(). Cipher names must be uppercased in order for OpenSSL to accept them.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  clientCertEngine?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Name of an OpenSSL engine which can provide the client certificate.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  crl?: string | Buffer<ArrayBufferLike> | (string | Buffer<ArrayBufferLike>)[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  PEM formatted CRLs (Certificate Revocation Lists).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  dhparam?: string | Buffer<ArrayBufferLike>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  'auto' or custom Diffie-Hellman parameters, required for non-ECDHE perfect forward secrecy. +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  clientCertEngine?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Name of an OpenSSL engine which can provide the client certificate.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  crl?: string | Buffer<ArrayBufferLike> | (string | Buffer<ArrayBufferLike>)[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  PEM formatted CRLs (Certificate Revocation Lists).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  dhparam?: string | Buffer<ArrayBufferLike>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  'auto' or custom Diffie-Hellman parameters, required for non-ECDHE perfect forward secrecy. If omitted or invalid, the parameters are silently discarded and DHE ciphers will not be available. ECDHE-based perfect forward secrecy will still be available.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ecdhCurve?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  A string describing a named curve or a colon separated list of curve +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ecdhCurve?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  A string describing a named curve or a colon separated list of curve NIDs or names, for example P-521:P-384:P-256, to use for ECDH key agreement. Set to auto to select the curve automatically. Use crypto.getCurves() to obtain a list of available curve names. On recent releases, openssl ecparam -list_curves will also display the name and description of each available elliptic curve. Default: tls.DEFAULT_ECDH_CURVE.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  enableTrace?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  When enabled, TLS packet trace information is written to stderr. This can be +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  enableTrace?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  When enabled, TLS packet trace information is written to stderr. This can be used to debug TLS connection problems.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  honorCipherOrder?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Attempt to use the server's cipher suite preferences instead of the +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  honorCipherOrder?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Attempt to use the server's cipher suite preferences instead of the client's. When true, causes SSL_OP_CIPHER_SERVER_PREFERENCE to be set in secureOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  host?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  key?:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | Buffer<ArrayBufferLike>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | (string | Buffer<ArrayBufferLike> | KeyObject)[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Private keys in PEM format. PEM allows the option of private keys +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  host?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  key?:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | Buffer<ArrayBufferLike>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | (string | Buffer<ArrayBufferLike> | KeyObject)[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Private keys in PEM format. PEM allows the option of private keys being encrypted. Encrypted keys will be decrypted with options.passphrase. Multiple keys using different algorithms can be provided either as an array of unencrypted key strings or buffers, @@ -111,13 +111,13 @@ passphrase: ]}. The object form can only occur in an array. object.passphrase is optional. Encrypted keys will be decrypted with object.passphrase if provided, or options.passphrase if it is not.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  lookup?: LookupFunction
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  maxVersion?: SecureVersion

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Optionally set the maximum TLS version to allow. One +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  lookup?: LookupFunction
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  maxVersion?: SecureVersion

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Optionally set the maximum TLS version to allow. One of 'TLSv1.3', 'TLSv1.2', 'TLSv1.1', or 'TLSv1'. Cannot be specified along with the secureProtocol option, use one or the other. Default: 'TLSv1.3', unless changed using CLI options. Using --tls-max-v1.2 sets the default to 'TLSv1.2'. Using --tls-max-v1.3 sets the default to 'TLSv1.3'. If multiple of the options are provided, the highest maximum is used.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  minDHSize?: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  minVersion?: SecureVersion

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Optionally set the minimum TLS version to allow. One +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  minDHSize?: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  minVersion?: SecureVersion

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Optionally set the minimum TLS version to allow. One of 'TLSv1.3', 'TLSv1.2', 'TLSv1.1', or 'TLSv1'. Cannot be specified along with the secureProtocol option, use one or the other. It is not recommended to use less than TLSv1.2, but it may be required for interoperability. @@ -125,8 +125,8 @@ --tls-v1.0 sets the default to 'TLSv1'. Using --tls-v1.1 sets the default to 'TLSv1.1'. Using --tls-min-v1.3 sets the default to 'TLSv1.3'. If multiple of the options are provided, the lowest minimum is used.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  passphrase?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Shared passphrase used for a single private key and/or a PFX.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  path?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  pfx?:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | Buffer<ArrayBufferLike>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | (string | Buffer<ArrayBufferLike> | PxfObject)[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  PFX or PKCS12 encoded private key and certificate chain. pfx is an +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  passphrase?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Shared passphrase used for a single private key and/or a PFX.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  path?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  pfx?:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | Buffer<ArrayBufferLike>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | (string | Buffer<ArrayBufferLike> | PxfObject)[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  PFX or PKCS12 encoded private key and certificate chain. pfx is an alternative to providing key and cert individually. PFX is usually encrypted, if it is, passphrase will be used to decrypt it. Multiple PFX can be provided either as an array of unencrypted PFX buffers, @@ -134,25 +134,39 @@ passphrase: ]}. The object form can only occur in an array. object.passphrase is optional. Encrypted PFX will be decrypted with object.passphrase if provided, or options.passphrase if it is not.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  port?: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  privateKeyEngine?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Name of an OpenSSL engine to get private key from. Should be used +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  port?: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  privateKeyEngine?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Name of an OpenSSL engine to get private key from. Should be used together with privateKeyIdentifier.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  privateKeyIdentifier?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Identifier of a private key managed by an OpenSSL engine. Should be +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  privateKeyIdentifier?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Identifier of a private key managed by an OpenSSL engine. Should be used together with privateKeyEngine. Should not be set together with key, because both options define a private key in different ways.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  rejectUnauthorized?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  If true the server will reject any connection which is not +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  pskCallback?: (hint: string) => PSKCallbackNegotation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  When negotiating TLS-PSK (pre-shared keys), this function is called +with optional identity hint provided by the server or null +in case of TLS 1.3 where hint was removed. +It will be necessary to provide a custom tls.checkServerIdentity() +for the connection as the default one will try to check hostname/IP +of the server against the certificate but that's not applicable for PSK +because there won't be a certificate present. +More information can be found in the RFC 4279.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • (hint: string): PSKCallbackNegotation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • hint: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        message sent from the server to help client +decide which identity to use during negotiation. +Always null if TLS 1.3 is used.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns PSKCallbackNegotation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return null to stop the negotiation process. psk must be +compatible with the selected cipher's digest. +identity must use UTF-8 encoding.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  rejectUnauthorized?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  If true the server will reject any connection which is not authorized with the list of supplied CAs. This option only has an effect if requestCert is true.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  true
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  requestCert?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  If true the server will request a certificate from clients that +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  requestCert?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  If true the server will request a certificate from clients that connect and attempt to verify that certificate. Defaults to false.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  secureContext?: SecureContext

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  An optional TLS context object from tls.createSecureContext()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  secureOptions?: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Optionally affect the OpenSSL protocol behavior, which is not +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  secureContext?: SecureContext

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  An optional TLS context object from tls.createSecureContext()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  secureOptions?: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Optionally affect the OpenSSL protocol behavior, which is not usually necessary. This should be used carefully if at all! Value is a numeric bitmask of the SSL_OP_* options from OpenSSL Options

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  secureProtocol?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Legacy mechanism to select the TLS protocol version to use, it does +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  secureProtocol?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Legacy mechanism to select the TLS protocol version to use, it does not support independent control of the minimum and maximum version, and does not support limiting the protocol to TLSv1.3. Use minVersion and maxVersion instead. The possible values are listed as @@ -161,36 +175,22 @@ any TLS protocol version up to TLSv1.3. It is not recommended to use TLS versions less than 1.2, but it may be required for interoperability. Default: none, see minVersion.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  servername?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  session?: Buffer<ArrayBufferLike>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  sessionIdContext?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Opaque identifier used by servers to ensure session state is not +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  servername?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  session?: Buffer<ArrayBufferLike>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  sessionIdContext?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Opaque identifier used by servers to ensure session state is not shared between applications. Unused by clients.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  sessionTimeout?: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The number of seconds after which a TLS session created by the +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  sessionTimeout?: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The number of seconds after which a TLS session created by the server will no longer be resumable. See Session Resumption for more information. Default: 300.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  sigalgs?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Colon-separated list of supported signature algorithms. The list +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  sigalgs?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Colon-separated list of supported signature algorithms. The list can contain digest algorithms (SHA256, MD5 etc.), public key algorithms (RSA-PSS, ECDSA etc.), combination of both (e.g 'RSA+SHA384') or TLS v1.3 scheme names (e.g. rsa_pss_pss_sha512).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  SNICallback?: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      servername: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      cb: (err: Error, ctx?: SecureContext) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  SNICallback(servername, cb) A function that will be +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  SNICallback?: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      servername: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      cb: (err: Error, ctx?: SecureContext) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  SNICallback(servername, cb) A function that will be called if the client supports SNI TLS extension. Two arguments will be passed when called: servername and cb. SNICallback should invoke cb(null, ctx), where ctx is a SecureContext instance. (tls.createSecureContext(...) can be used to get a proper SecureContext.) If SNICallback wasn't provided the default callback with high-level API will be used (see below).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  socket?: Duplex
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ticketKeys?: Buffer<ArrayBufferLike>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  48-bytes of cryptographically strong pseudo-random data. +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  socket?: Duplex
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ticketKeys?: Buffer<ArrayBufferLike>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  48-bytes of cryptographically strong pseudo-random data. See Session Resumption for more information.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  timeout?: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • When negotiating TLS-PSK (pre-shared keys), this function is called -with optional identity hint provided by the server or null -in case of TLS 1.3 where hint was removed. -It will be necessary to provide a custom tls.checkServerIdentity() -for the connection as the default one will try to check hostname/IP -of the server against the certificate but that's not applicable for PSK -because there won't be a certificate present. -More information can be found in the RFC 4279.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • hint: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      message sent from the server to help client -decide which identity to use during negotiation. -Always null if TLS 1.3 is used.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns PSKCallbackNegotation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return null to stop the negotiation process. psk must be -compatible with the selected cipher's digest. -identity must use UTF-8 encoding.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  timeout?: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/interfaces/_internal_.ContactObject.html b/docs/interfaces/_internal_.ContactObject.html index 2c9e088c..c70e25a7 100644 --- a/docs/interfaces/_internal_.ContactObject.html +++ b/docs/interfaces/_internal_.ContactObject.html @@ -1,4 +1,4 @@ -ContactObject | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    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.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      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 5c948b25..56260e0f 100644 --- a/docs/interfaces/_internal_.Context.html +++ b/docs/interfaces/_internal_.Context.html @@ -1,6 +1,6 @@ Context | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        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 +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        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 clientContext? functionName diff --git a/docs/interfaces/_internal_.CopyOperation.html b/docs/interfaces/_internal_.CopyOperation.html index 38374fb4..7de4ee41 100644 --- a/docs/interfaces/_internal_.CopyOperation.html +++ b/docs/interfaces/_internal_.CopyOperation.html @@ -1,4 +1,4 @@ -CopyOperation | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          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.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            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 760e7920..1bf1ff1f 100644 --- a/docs/interfaces/_internal_.DefaultExtensionConfiguration.html +++ b/docs/interfaces/_internal_.DefaultExtensionConfiguration.html @@ -1,8 +1,8 @@ DefaultExtensionConfiguration | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns Provider<RetryStrategy | RetryStrategyV2>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/interfaces/_internal_.DeserializeHandlerOutput.html b/docs/interfaces/_internal_.DeserializeHandlerOutput.html index cf4271e8..f3db8b7f 100644 --- a/docs/interfaces/_internal_.DeserializeHandlerOutput.html +++ b/docs/interfaces/_internal_.DeserializeHandlerOutput.html @@ -1,8 +1,8 @@ -DeserializeHandlerOutput | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                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.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  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 response, you need to guard its type to e.g. HttpResponse with 'instanceof' operand.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  During the deserialize phase of the execution of a middleware stack, a deserialized response may or may not be available

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/interfaces/_internal_.DetailedPeerCertificate.html b/docs/interfaces/_internal_.DetailedPeerCertificate.html new file mode 100644 index 00000000..9777594a --- /dev/null +++ b/docs/interfaces/_internal_.DetailedPeerCertificate.html @@ -0,0 +1,53 @@ +DetailedPeerCertificate | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    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? +ext_key_usage? +fingerprint +fingerprint256 +fingerprint512 +infoAccess? +issuer +issuerCertificate +modulus? +nistCurve? +pubkey? +raw +serialNumber +subject +subjectaltname? +valid_from +valid_to +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    asn1Curve?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The ASN.1 name of the OID of the elliptic curve. +Well-known curves are identified by an OID. +While it is unusual, it is possible that the curve +is identified by its mathematical properties, +in which case it will not have an OID.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    bits?: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    For RSA keys: The RSA bit size.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    For EC keys: The key size in bits.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ca: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    true if a Certificate Authority (CA), false otherwise.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    v18.13.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    exponent?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The RSA exponent, as a string in hexadecimal number notation.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ext_key_usage?: string[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The extended key usage, a set of OIDs.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    fingerprint: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The SHA-1 digest of the DER encoded certificate. +It is returned as a : separated hexadecimal string.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    fingerprint256: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The SHA-256 digest of the DER encoded certificate. +It is returned as a : separated hexadecimal string.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    fingerprint512: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The SHA-512 digest of the DER encoded certificate. +It is returned as a : separated hexadecimal string.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    infoAccess?: Dict<string[]>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    An array describing the AuthorityInfoAccess, used with OCSP.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    issuer: Certificate

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The certificate issuer, described in the same terms as the subject.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    issuerCertificate: DetailedPeerCertificate

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The issuer certificate object. +For self-signed certificates, this may be a circular reference.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    modulus?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The RSA modulus, as a hexadecimal string.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    nistCurve?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The NIST name for the elliptic curve, if it has one +(not all well-known curves have been assigned names by NIST).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    pubkey?: NonSharedBuffer

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The public key.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    raw: NonSharedBuffer

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The DER encoded X.509 certificate data.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    serialNumber: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The certificate serial number, as a hex string.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    subject: Certificate

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The certificate subject.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    subjectaltname?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    A string containing concatenated names for the subject, +an alternative to the subject names.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    valid_from: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The date-time the certificate is valid from.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    valid_to: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The date-time the certificate is valid to.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/interfaces/_internal_.Dict.html b/docs/interfaces/_internal_.Dict.html index 1418c816..f96e541e 100644 --- a/docs/interfaces/_internal_.Dict.html +++ b/docs/interfaces/_internal_.Dict.html @@ -1 +1 @@ -Dict | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      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.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        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 fce7f24d..e6806eac 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.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          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 @@ -28,54 +28,54 @@ toJSON toString

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "[NODE_TYPE]": symbol
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          comment: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          A comment immediately after this Document

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          commentBefore: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          A comment before this Document

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          contents: Strict extends true ? Contents : Contents

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The document contents.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          directives: Directives
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          errors: YAMLError[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Errors encountered during parsing.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          options: Required<
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Omit<
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ParseOptions & DocumentOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  "_directives"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | "lineCounter"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | "version",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              >,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          >
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          range: Range

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The [start, value-end, node-end] character offsets for the part of the +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          commentBefore: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          A comment before this Document

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          contents: Strict extends true ? Contents : Contents

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The document contents.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          directives: Directives
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          errors: YAMLError[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Errors encountered during parsing.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          options: Required<
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Omit<
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ParseOptions & DocumentOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  "_directives"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | "lineCounter"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | "version",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              >,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          >
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          range: Range

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The [start, value-end, node-end] character offsets for the part of the source parsed into this document (undefined if not parsed). The value-end and node-end positions are themselves not included in their respective ranges.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          schema: Schema

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The schema used with the document. Use setSchema() to change.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          warnings: YAMLWarning[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Warnings encountered during parsing.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Adds a value to the document.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • value: any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Adds a value to the document.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          schema: Schema

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The schema used with the document. Use setSchema() to change.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          warnings: YAMLWarning[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Warnings encountered during parsing.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Adds a value to the document.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • value: any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Adds a value to the document.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Create a new Alias node, ensuring that the target node has the required anchor.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns Document<Contents, Strict>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Create a new Alias node, ensuring that the target node has the required anchor.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            If node already has an anchor, name is ignored. Otherwise, the node.anchor value will be set to name, or if an anchor with that name is already present in the document, name will be used as a prefix for a new unique anchor. If name is undefined, the generated anchor will use 'a' as a prefix.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • node: Strict extends true
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ? Scalar<unknown>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | YAMLMap<unknown, unknown>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | YAMLSeq<unknown>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  : Node
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Optionalname: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns Alias

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Convert any value into a Node using the current schema, recursively +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • node: Strict extends true
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ? Scalar<unknown>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | YAMLMap<unknown, unknown>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | YAMLSeq<unknown>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  : Node
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Optionalname: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns Alias

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Convert a key and a value into a Pair using the current schema, recursively wrapping all values as Scalar or Collection nodes.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns Pair<K, V>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Removes a value from the document.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns Pair<K, V>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Removes a value from the document.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • key: unknown

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            true if the item was found and removed.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Removes a value from the document.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Removes a value from the document.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            true if the item was found and removed.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Returns item at key, or undefined if not found. By default unwraps +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Returns item at key, or undefined if not found. By default unwraps scalar values from their surrounding node; to disable set keepScalar to true (collections are always returned intact).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • key: unknown
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • OptionalkeepScalar: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns Strict extends true ? unknown : any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Returns item at path, or undefined if not found. By default unwraps +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • key: unknown
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • OptionalkeepScalar: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns Strict extends true ? unknown : any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Returns item at path, or undefined if not found. By default unwraps scalar values from their surrounding node; to disable set keepScalar to true (collections are always returned intact).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • path: Iterable<unknown, any, any>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • OptionalkeepScalar: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns Strict extends true ? unknown : any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Checks if the document includes a value with the key key.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • key: unknown

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Checks if the document includes a value at path.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Sets a value in this document. For !!set, value needs to be a +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • path: Iterable<unknown, any, any>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • OptionalkeepScalar: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns Strict extends true ? unknown : any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Checks if the document includes a value with the key key.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • key: unknown

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Checks if the document includes a value at path.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Sets a value in this document. For !!set, value needs to be a boolean to add/remove the item from the set.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • key: any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • value: unknown

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Sets a value in this document. For !!set, value needs to be a +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • key: any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • value: unknown

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Sets a value in this document. For !!set, value needs to be a boolean to add/remove the item from the set.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • path: Iterable<unknown, any, any>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • value: unknown

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Change the YAML version and schema used by the document. +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • path: Iterable<unknown, any, any>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • value: unknown

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Change the YAML version and schema used by the document. A null version disables support for directives, explicit tags, anchors, and aliases. It also requires the schema option to be given as a Schema instance value.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Overrides all previously set schema options.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • A plain JavaScript representation of the document contents.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Optionalopt: ToJSOptions & { [ignored: string]: unknown }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • A JSON representation of the document contents.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • A plain JavaScript representation of the document contents.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Optionalopt: ToJSOptions & { [ignored: string]: unknown }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • A JSON representation of the document contents.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • OptionaljsonArg: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Used by JSON.stringify to indicate the array index or property name.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • OptionalonAnchor: (value: unknown, count: number) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • OptionalonAnchor: (value: unknown, count: number) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Returns any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/interfaces/_internal_.Encoder.html b/docs/interfaces/_internal_.Encoder.html index 5868cbc0..5af8ae33 100644 --- a/docs/interfaces/_internal_.Encoder.html +++ b/docs/interfaces/_internal_.Encoder.html @@ -8,4 +8,4 @@ Runtime support is limited to Uint8Array and string by default.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          You may choose to support more encoder input types if overriding the default implementations.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • input: any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • input: any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/interfaces/_internal_.EncodingObject.html b/docs/interfaces/_internal_.EncodingObject.html index 90e89560..041c6cae 100644 --- a/docs/interfaces/_internal_.EncodingObject.html +++ b/docs/interfaces/_internal_.EncodingObject.html @@ -1 +1 @@ -EncodingObject | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            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.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              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_.EndpointBearer.html b/docs/interfaces/_internal_.EndpointBearer.html new file mode 100644 index 00000000..58c565f7 --- /dev/null +++ b/docs/interfaces/_internal_.EndpointBearer.html @@ -0,0 +1,3 @@ +EndpointBearer | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Interface EndpointBearer

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Interface for object requires an Endpoint set.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                interface EndpointBearer {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    endpoint: Provider<Endpoint>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                endpoint +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                endpoint: Provider<Endpoint>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/interfaces/_internal_.EndpointInputConfig.html b/docs/interfaces/_internal_.EndpointInputConfig.html index 3da50f27..1dd61517 100644 --- a/docs/interfaces/_internal_.EndpointInputConfig.html +++ b/docs/interfaces/_internal_.EndpointInputConfig.html @@ -1,7 +1,7 @@ EndpointInputConfig | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Interface EndpointInputConfig<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Endpoint config interfaces and resolver for Endpoint v2. They live in separate package to allow per-service onboarding. When all services onboard Endpoint v2, the resolver in config-resolver package can be removed. This interface includes all the endpoint parameters with built-in bindings of "AWS::" and "SDK::"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  interface EndpointInputConfig<T extends EndpointParameters = EndpointParameters> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      endpoint?:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | EndpointV2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | Endpoint
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | Provider<Endpoint>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | Provider<EndpointV2>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      endpointProvider?: (params: T, context?: { logger?: Logger }) => EndpointV2;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      serviceConfiguredEndpoint?: never;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      tls?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      useDualstackEndpoint?: boolean | Provider<boolean>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      useFipsEndpoint?: boolean | Provider<boolean>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  endpoint? +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  interface EndpointInputConfig<T extends EndpointParameters = EndpointParameters> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      endpoint?:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | EndpointV2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | Endpoint
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | Provider<Endpoint>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | Provider<EndpointV2>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      endpointProvider?: (params: T, context?: { logger?: Logger }) => EndpointV2;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      serviceConfiguredEndpoint?: never;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      tls?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      useDualstackEndpoint?: boolean | Provider<boolean>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      useFipsEndpoint?: boolean | Provider<boolean>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  endpoint? endpointProvider? serviceConfiguredEndpoint? tls? @@ -11,11 +11,11 @@ a custom endpoint (for example, when using a local version of S3).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Endpoint transformations such as S3 applying a bucket to the hostname are still applicable to this custom endpoint.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  endpointProvider?: (params: T, context?: { logger?: Logger }) => EndpointV2

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Providing a custom endpointProvider will override +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  endpointProvider?: (params: T, context?: { logger?: Logger }) => EndpointV2

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Providing a custom endpointProvider will override built-in transformations of the endpoint such as S3 adding the bucket name to the hostname, since they are part of the default endpointProvider.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  serviceConfiguredEndpoint?: never

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  This field is used internally so you should not fill any value to this field.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  tls?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Whether TLS is enabled for requests.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  serviceConfiguredEndpoint?: never

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  This field is used internally so you should not fill any value to this field.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  tls?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Whether TLS is enabled for requests.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  useDualstackEndpoint?: boolean | Provider<boolean>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Enables IPv6/IPv4 dualstack endpoint.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  useFipsEndpoint?: boolean | Provider<boolean>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Enables FIPS compatible endpoints.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  useFipsEndpoint?: boolean | Provider<boolean>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Enables FIPS compatible endpoints.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/interfaces/_internal_.EndpointParameters.html b/docs/interfaces/_internal_.EndpointParameters.html index 608f1c18..06e4538a 100644 --- a/docs/interfaces/_internal_.EndpointParameters.html +++ b/docs/interfaces/_internal_.EndpointParameters.html @@ -1,4 +1,4 @@ -EndpointParameters | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Interface EndpointParameters

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Indexable

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Interface EndpointParameters

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Indexable

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Accelerate? Bucket? CopySource? DisableAccessPoints? diff --git a/docs/interfaces/_internal_.ErrnoException.html b/docs/interfaces/_internal_.ErrnoException.html index 85353640..b34b0b2d 100644 --- a/docs/interfaces/_internal_.ErrnoException.html +++ b/docs/interfaces/_internal_.ErrnoException.html @@ -1,4 +1,4 @@ -ErrnoException | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        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.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          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 @@ -6,4 +6,4 @@ path? stack? syscall? -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          cause?: unknown
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          code?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          errno?: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          message: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          name: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          path?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          stack?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          syscall?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          cause?: unknown
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          code?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          errno?: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          message: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          name: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          path?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          stack?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          syscall?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/interfaces/_internal_.Event-1.html b/docs/interfaces/_internal_.Event-1.html index a5bb0a46..3b7a745c 100644 --- a/docs/interfaces/_internal_.Event-1.html +++ b/docs/interfaces/_internal_.Event-1.html @@ -1,4 +1,4 @@ -Event | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            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;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            bubbles +Event | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              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;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              bubbles cancelable cancelBubble composed @@ -16,4 +16,4 @@ preventDefault stopImmediatePropagation stopPropagation -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • type: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Optionalbubbles: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Optionalcancelable: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Returns [EventTarget?]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • type: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Optionalbubbles: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Optionalcancelable: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/interfaces/_internal_.Event.html b/docs/interfaces/_internal_.Event.html index 20d485fc..46e73ff1 100644 --- a/docs/interfaces/_internal_.Event.html +++ b/docs/interfaces/_internal_.Event.html @@ -1,4 +1,4 @@ -Event | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                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.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  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 @@ -16,4 +16,4 @@ preventDefault stopImmediatePropagation stopPropagation -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Returns [EventTarget?]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • type: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Optionalbubbles: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Optionalcancelable: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Returns [EventTarget?]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • type: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Optionalbubbles: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Optionalcancelable: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/interfaces/_internal_.EventEmitter.Abortable.html b/docs/interfaces/_internal_.EventEmitter.Abortable.html index 2a703dc0..11214ed0 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.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Interface Abortable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    interface Abortable {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        signal?: AbortSignal;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    signal? +Abortable | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      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
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/interfaces/_internal_.EventEmitter.EventEmitterAsyncResourceOptions.html b/docs/interfaces/_internal_.EventEmitter.EventEmitterAsyncResourceOptions.html index 37f95513..9c1fcce0 100644 --- a/docs/interfaces/_internal_.EventEmitter.EventEmitterAsyncResourceOptions.html +++ b/docs/interfaces/_internal_.EventEmitter.EventEmitterAsyncResourceOptions.html @@ -1,14 +1,14 @@ -EventEmitterAsyncResourceOptions | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        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.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Interface EventEmitterAsyncResourceOptions

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          captureRejections? name? requireManualDestroy? triggerAsyncId?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          captureRejections?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Enables automatic capturing of promise rejection.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          name?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The type of async event, this is required when instantiating EventEmitterAsyncResource +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          name?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The type of async event, this is required when instantiating EventEmitterAsyncResource directly rather than as a child class.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          new.target.name if instantiated as a child class.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          requireManualDestroy?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Disables automatic emitDestroy when the object is garbage collected. +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          requireManualDestroy?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Disables automatic emitDestroy when the object is garbage collected. This usually does not need to be set (even if emitDestroy is called manually), unless the resource's asyncId is retrieved and the sensitive API's emitDestroy is called with it.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/interfaces/_internal_.EventEmitter.EventEmitterReferencingAsyncResource.html b/docs/interfaces/_internal_.EventEmitter.EventEmitterReferencingAsyncResource.html index a59894b3..d6e4130d 100644 --- a/docs/interfaces/_internal_.EventEmitter.EventEmitterReferencingAsyncResource.html +++ b/docs/interfaces/_internal_.EventEmitter.EventEmitterReferencingAsyncResource.html @@ -6,28 +6,28 @@ 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          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 runInAsyncScope triggerAsyncId -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          eventEmitter: EventEmitterAsyncResource

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Returns number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The unique asyncId assigned to the resource.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Binds the given function to execute to this AsyncResource's scope.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          eventEmitter: EventEmitterAsyncResource

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Returns number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The unique asyncId assigned to the resource.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Binds the given function to execute to this AsyncResource's scope.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Func extends (...args: any[]) => any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • fn: Func

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The function to bind to the current AsyncResource.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns Func

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            v14.8.0, v12.19.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Call all destroy hooks. This should only ever be called once. An error will +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns Func

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          v14.8.0, v12.19.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Call all destroy hooks. This should only ever be called once. An error will be thrown if it is called more than once. This must be manually called. If the resource is left to be collected by the GC then the destroy hooks will never be called.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            A reference to asyncResource.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Call the provided function with the provided arguments in the execution context +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Call the provided function with the provided arguments in the execution context of the async resource. This will establish the context, trigger the AsyncHooks before callbacks, call the function, trigger the AsyncHooks after callbacks, and then restore the original execution context.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • This
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Result

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • fn: (this: This, ...args: any[]) => Result

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The function to call in the execution context of this async resource.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • OptionalthisArg: This

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The receiver to be used for the function call.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • ...args: any[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Optional arguments to pass to the function.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns Result

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            v9.6.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Returns number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The same triggerAsyncId that is passed to the AsyncResource constructor.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • OptionalthisArg: This

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The receiver to be used for the function call.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • ...args: any[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Optional arguments to pass to the function.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Returns Result

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          v9.6.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Returns number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The same triggerAsyncId that is passed to the AsyncResource constructor.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/interfaces/_internal_.EventEmitter.NodeEventTarget.html b/docs/interfaces/_internal_.EventEmitter.NodeEventTarget.html new file mode 100644 index 00000000..2cd9edcb --- /dev/null +++ b/docs/interfaces/_internal_.EventEmitter.NodeEventTarget.html @@ -0,0 +1,57 @@ +NodeEventTarget | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            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 +addListener +dispatchEvent +emit +eventNames +getMaxListeners +listenerCount +off +on +once +removeAllListeners +removeEventListener +removeListener +setMaxListeners +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Node.js-specific extension to the EventTarget class that emulates the +equivalent EventEmitter API. The only difference between addListener() and +addEventListener() is that addListener() will return a reference to the +EventTarget.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • type: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • listener: (arg: any) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              v14.5.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Node.js-specific extension to the EventTarget class that dispatches the +arg to the list of handlers for type.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • type: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • arg: any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              true if event listeners registered for the type exist, +otherwise false.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              v15.2.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Node.js-specific extension to the EventTarget class that returns an array +of event type names for which event listeners are registered.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns string[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              14.5.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Node.js-specific extension to the EventTarget class that returns the number +of max event listeners.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              v14.5.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Node.js-specific extension to the EventTarget class that returns the number +of event listeners registered for the type.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • type: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              v14.5.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Node.js-specific alias for eventTarget.removeEventListener().

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              v14.5.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Node.js-specific alias for eventTarget.addEventListener().

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • type: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • listener: (arg: any) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              v14.5.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Node.js-specific extension to the EventTarget class that adds a once +listener for the given event type. This is equivalent to calling on +with the once option set to true.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • type: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • listener: (arg: any) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              v14.5.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Node.js-specific extension to the EventTarget class. If type is specified, +removes all registered listeners for type, otherwise removes all registered +listeners.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Optionaltype: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              v14.5.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Node.js-specific extension to the EventTarget class that removes the +listener for the given type. The only difference between removeListener() +and removeEventListener() is that removeListener() will return a reference +to the EventTarget.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              v14.5.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Node.js-specific extension to the EventTarget class that sets the number +of max event listeners as n.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • n: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              v14.5.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/interfaces/_internal_.EventEmitter.html b/docs/interfaces/_internal_.EventEmitter.html index 8ea9e46d..2937413e 100644 --- a/docs/interfaces/_internal_.EventEmitter.html +++ b/docs/interfaces/_internal_.EventEmitter.html @@ -1,4 +1,4 @@ -EventEmitter | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              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.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                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 @@ -14,38 +14,38 @@ removeAllListeners removeListener setMaxListeners -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • K

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Alias for emitter.on(eventName, listener).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • K

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Alias for emitter.on(eventName, listener).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • K

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  v0.1.26

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns true if the event had listeners, false otherwise.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  import { EventEmitter } from 'node:events';
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  const myEmitter = new EventEmitter();

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  // First listener
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  myEmitter.on('event', function firstListener() {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    console.log('Helloooo! first listener');
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  });
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  // Second listener
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  myEmitter.on('event', function secondListener(arg1, arg2) {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    console.log(`event with parameters ${arg1}, ${arg2} in second listener`);
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  });
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  // Third listener
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  myEmitter.on('event', function thirdListener(...args) {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    const parameters = args.join(', ');
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    console.log(`event with parameters ${parameters} in third listener`);
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  });

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  console.log(myEmitter.listeners('event'));

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  myEmitter.emit('event', 1, 2, 3, 4, 5);

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  // Prints:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  // [
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  //   [Function: firstListener],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  //   [Function: secondListener],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  //   [Function: thirdListener]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  // ]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  // Helloooo! first listener
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  // event with parameters 1, 2 in second listener
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  // event with parameters 1, 2, 3, 4, 5 in third listener

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • K

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  v0.1.26

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Returns an array listing the events for which the emitter has registered +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Returns an array listing the events for which the emitter has registered listeners. The values in the array are strings or Symbols.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  import { EventEmitter } from 'node:events';

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  const myEE = new EventEmitter();
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  myEE.on('foo', () => {});
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  myEE.on('bar', () => {});

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  const sym = Symbol('symbol');
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  myEE.on(sym, () => {});

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  console.log(myEE.eventNames());
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  // Prints: [ 'foo', 'bar', Symbol(symbol) ]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns ((string | symbol) & Key2<unknown, T>)[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  v6.0.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Returns the current max listener value for the EventEmitter which is either +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Returns the current max listener value for the EventEmitter which is either set by emitter.setMaxListeners(n) or defaults to EventEmitter.defaultMaxListeners.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  v1.0.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Returns the number of listeners listening for the event named eventName. +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Returns the number of listeners listening for the event named eventName. If listener is provided, it will return how many times the listener is found in the list of the listeners of the event.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • K

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • eventName: Key<K, T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The name of the event being listened for

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Optionallistener: Listener<K, T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The event handler function

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  v3.2.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Returns a copy of the array of listeners for the event named eventName.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Optionallistener: Listener<K, T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The event handler function

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                v3.2.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Returns a copy of the array of listeners for the event named eventName.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  server.on('connection', (stream) => {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    console.log('someone connected!');
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  });
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  console.log(util.inspect(server.listeners('connection')));
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  // Prints: [ [Function] ]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • K

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns Listener<K, T, Function>[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  v0.1.26

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Alias for emitter.removeListener().

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Alias for emitter.removeListener().

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • K

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  v10.0.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Adds the listener function to the end of the listeners array for the event +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Adds the listener function to the end of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  @@ -59,9 +59,9 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • K

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • eventName: Key<K, T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The name of the event.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • listener: Listener<K, T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The callback function

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  v0.1.101

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Adds a one-time listener function for the event named eventName. The +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • listener: Listener<K, T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The callback function

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                v0.1.101

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Adds a one-time listener function for the event named eventName. The next time eventName is triggered, this listener is removed and then invoked.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  server.once('connection', (stream) => {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    console.log('Ah, we have our first user!');
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  });
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  @@ -73,9 +73,9 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • K

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • eventName: Key<K, T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The name of the event.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • listener: Listener<K, T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The callback function

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  v0.3.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Adds the listener function to the beginning of the listeners array for the +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • listener: Listener<K, T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The callback function

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                v0.3.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Adds the listener function to the beginning of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  @@ -84,30 +84,30 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns a reference to the EventEmitter, so that calls can be chained.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • K

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • eventName: Key<K, T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The name of the event.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • listener: Listener<K, T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The callback function

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  v6.0.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Adds a one-timelistener function for the event named eventName to the beginning of the listeners array. The next time eventName is triggered, this +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • listener: Listener<K, T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The callback function

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                v6.0.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Adds a one-timelistener function for the event named eventName to the beginning of the listeners array. The next time eventName is triggered, this listener is removed, and then invoked.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  server.prependOnceListener('connection', (stream) => {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    console.log('Ah, we have our first user!');
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  });

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns a reference to the EventEmitter, so that calls can be chained.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • K

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • eventName: Key<K, T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The name of the event.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • listener: Listener<K, T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The callback function

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  v6.0.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Returns a copy of the array of listeners for the event named eventName, +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • listener: Listener<K, T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The callback function

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                v6.0.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Returns a copy of the array of listeners for the event named eventName, including any wrappers (such as those created by .once()).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  import { EventEmitter } from 'node:events';
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  const emitter = new EventEmitter();
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  emitter.once('log', () => console.log('log once'));

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  // Returns a new Array with a function `onceWrapper` which has a property
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  // `listener` which contains the original listener bound above
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  const listeners = emitter.rawListeners('log');
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  const logFnWrapper = listeners[0];

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  // Logs "log once" to the console and does not unbind the `once` event
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  logFnWrapper.listener();

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  // Logs "log once" to the console and removes the listener
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  logFnWrapper();

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  emitter.on('log', () => console.log('log persistently'));
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  // Will return a new Array with a single function bound by `.on()` above
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  const newListeners = emitter.rawListeners('log');

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  // Logs "log persistently" twice
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  newListeners[0]();
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  emitter.emit('log');

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • K

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns Listener<K, T, Function>[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  v9.4.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Removes all listeners, or those of the specified eventName.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Removes all listeners, or those of the specified eventName.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  It is bad practice to remove listeners added elsewhere in the code, particularly when the EventEmitter instance was created by some other component or module (e.g. sockets or file streams).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns a reference to the EventEmitter, so that calls can be chained.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • OptionaleventName: Key<unknown, T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  v0.1.26

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Removes the specified listener from the listener array for the event named eventName.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Removes the specified listener from the listener array for the event named eventName.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  const callback = (stream) => {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    console.log('someone connected!');
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  server.on('connection', callback);
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  // ...
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  server.removeListener('connection', callback);
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  @@ -134,10 +134,10 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns a reference to the EventEmitter, so that calls can be chained.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • K

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  v0.1.26

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • By default EventEmitters will print a warning if more than 10 listeners are +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • By default EventEmitters will print a warning if more than 10 listeners are added for a particular event. This is a useful default that helps finding memory leaks. The emitter.setMaxListeners() method allows the limit to be modified for this specific EventEmitter instance. The value can be set to Infinity (or 0) to indicate an unlimited number of listeners.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns a reference to the EventEmitter, so that calls can be chained.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • n: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  v0.3.5

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/interfaces/_internal_.EventEmitterOptions.html b/docs/interfaces/_internal_.EventEmitterOptions.html index 293c4bf6..e27cf8e9 100644 --- a/docs/interfaces/_internal_.EventEmitterOptions.html +++ b/docs/interfaces/_internal_.EventEmitterOptions.html @@ -1,3 +1,3 @@ -EventEmitterOptions | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Interface EventEmitterOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  interface EventEmitterOptions {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      captureRejections?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  captureRejections? +EventEmitterOptions | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    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
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/interfaces/_internal_.EventInit.html b/docs/interfaces/_internal_.EventInit.html index 5da76d77..013c2b1e 100644 --- a/docs/interfaces/_internal_.EventInit.html +++ b/docs/interfaces/_internal_.EventInit.html @@ -1,4 +1,4 @@ -EventInit | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Interface EventInit

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      interface EventInit {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          bubbles?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          cancelable?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          composed?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      bubbles? +EventInit | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Interface EventInit

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        interface EventInit {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            bubbles?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            cancelable?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            composed?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        bubbles? cancelable? composed? -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        bubbles?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        cancelable?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        composed?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        bubbles?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        cancelable?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        composed?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/interfaces/_internal_.EventListener.html b/docs/interfaces/_internal_.EventListener.html index 5785aeff..c4ddeb92 100644 --- a/docs/interfaces/_internal_.EventListener.html +++ b/docs/interfaces/_internal_.EventListener.html @@ -1 +1 @@ -EventListener | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Interface EventListener

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +EventListener | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Interface EventListener

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/interfaces/_internal_.EventListenerObject.html b/docs/interfaces/_internal_.EventListenerObject.html index 9955f417..6ca24587 100644 --- a/docs/interfaces/_internal_.EventListenerObject.html +++ b/docs/interfaces/_internal_.EventListenerObject.html @@ -1,2 +1,2 @@ -EventListenerObject | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Interface EventListenerObject

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              interface EventListenerObject {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  handleEvent(object: Event): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              handleEvent -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +EventListenerObject | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Interface EventListenerObject

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                interface EventListenerObject {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    handleEvent(object: Event): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                handleEvent +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/interfaces/_internal_.EventListenerOptions-1.html b/docs/interfaces/_internal_.EventListenerOptions-1.html new file mode 100644 index 00000000..1dd49fa1 --- /dev/null +++ b/docs/interfaces/_internal_.EventListenerOptions-1.html @@ -0,0 +1,2 @@ +EventListenerOptions | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  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 40054ccc..71cd2e45 100644 --- a/docs/interfaces/_internal_.EventListenerOptions.html +++ b/docs/interfaces/_internal_.EventListenerOptions.html @@ -1,2 +1,2 @@ -EventListenerOptions | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    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
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +EventListenerOptions | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      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_.EventStreamMarshaller.html b/docs/interfaces/_internal_.EventStreamMarshaller.html index 9f7b67e7..4e8f72d3 100644 --- a/docs/interfaces/_internal_.EventStreamMarshaller.html +++ b/docs/interfaces/_internal_.EventStreamMarshaller.html @@ -1,5 +1,5 @@ EventStreamMarshaller | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Interface EventStreamMarshaller<StreamType>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        An interface which provides functions for serializing and deserializing binary event stream to/from corresponsing modeled shape.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        interface EventStreamMarshaller<StreamType = any> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            deserialize: EventStreamMarshallerDeserFn<StreamType>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            serialize: EventStreamMarshallerSerFn<StreamType>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • StreamType = any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        deserialize +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        interface EventStreamMarshaller<StreamType = any> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            deserialize: EventStreamMarshallerDeserFn<StreamType>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            serialize: EventStreamMarshallerSerFn<StreamType>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • StreamType = any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        deserialize serialize

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        deserialize: EventStreamMarshallerDeserFn<StreamType>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        serialize: EventStreamMarshallerSerFn<StreamType>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/interfaces/_internal_.EventStreamMarshallerDeserFn.html b/docs/interfaces/_internal_.EventStreamMarshallerDeserFn.html index ff5ace86..b0c61ee2 100644 --- a/docs/interfaces/_internal_.EventStreamMarshallerDeserFn.html +++ b/docs/interfaces/_internal_.EventStreamMarshallerDeserFn.html @@ -1,2 +1,2 @@ EventStreamMarshallerDeserFn | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Interface EventStreamMarshallerDeserFn<StreamType>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          A function which deserializes binary event stream message into modeled shape.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • StreamType

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • StreamType

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/interfaces/_internal_.EventStreamMarshallerSerFn.html b/docs/interfaces/_internal_.EventStreamMarshallerSerFn.html index 9719906e..bba2d674 100644 --- a/docs/interfaces/_internal_.EventStreamMarshallerSerFn.html +++ b/docs/interfaces/_internal_.EventStreamMarshallerSerFn.html @@ -1,2 +1,2 @@ EventStreamMarshallerSerFn | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Interface EventStreamMarshallerSerFn<StreamType>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            A function that serializes modeled shape into binary stream message.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • StreamType

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • StreamType

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/interfaces/_internal_.EventTarget-1.html b/docs/interfaces/_internal_.EventTarget-1.html index 01ba836b..c3989701 100644 --- a/docs/interfaces/_internal_.EventTarget-1.html +++ b/docs/interfaces/_internal_.EventTarget-1.html @@ -1,4 +1,4 @@ -EventTarget | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              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;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              addEventListener +EventTarget | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                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;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                addEventListener dispatchEvent removeEventListener -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/interfaces/_internal_.EventTarget.html b/docs/interfaces/_internal_.EventTarget.html index e629abeb..2e34ee1a 100644 --- a/docs/interfaces/_internal_.EventTarget.html +++ b/docs/interfaces/_internal_.EventTarget.html @@ -1,4 +1,4 @@ -EventTarget | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  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.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    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
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    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 68fcd03b..5e37440f 100644 --- a/docs/interfaces/_internal_.ExternalDocumentationObject.html +++ b/docs/interfaces/_internal_.ExternalDocumentationObject.html @@ -1,3 +1,3 @@ -ExternalDocumentationObject | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      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.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        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_.FetchHttpHandlerOptions.html b/docs/interfaces/_internal_.FetchHttpHandlerOptions.html index b8a23c80..ac9a9fe9 100644 --- a/docs/interfaces/_internal_.FetchHttpHandlerOptions.html +++ b/docs/interfaces/_internal_.FetchHttpHandlerOptions.html @@ -1,26 +1,26 @@ FetchHttpHandlerOptions | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Interface FetchHttpHandlerOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Represents the http options that can be passed to a browser http client.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          interface FetchHttpHandlerOptions {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              cache?:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | "default"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | "force-cache"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | "no-cache"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | "no-store"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | "only-if-cached"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | "reload";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              credentials?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              keepAlive?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              requestInit?: (httpRequest: HttpRequest) => RequestInit;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              requestTimeout?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          cache? +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          interface FetchHttpHandlerOptions {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              cache?:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | "default"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | "force-cache"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | "no-cache"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | "no-store"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | "only-if-cached"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | "reload";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              credentials?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              keepAlive?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              requestInit?: (httpRequest: HttpRequest) => RequestInit;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              requestTimeout?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          cache? credentials? keepAlive? requestInit? requestTimeout?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          cache?:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | "default"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | "force-cache"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | "no-cache"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | "no-store"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | "only-if-cached"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | "reload"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Cache settings for fetch.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          https://developer.mozilla.org/en-US/docs/Web/API/Request/cache

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          credentials?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          A string indicating whether credentials will be sent with the request always, never, or +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          credentials?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          A string indicating whether credentials will be sent with the request always, never, or only when sent to a same-origin URL.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          https://developer.mozilla.org/en-US/docs/Web/API/Request/credentials

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          keepAlive?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Whether to allow the request to outlive the page. Default value is false.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          keepAlive?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Whether to allow the request to outlive the page. Default value is false.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          There may be limitations to the payload size, number of concurrent requests, request duration etc. when using keepalive in browsers.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          These may change over time, so look for up to date information about these limitations before enabling keepalive.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          requestInit?: (httpRequest: HttpRequest) => RequestInit

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          An optional function that produces additional RequestInit +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          requestInit?: (httpRequest: HttpRequest) => RequestInit

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          An optional function that produces additional RequestInit parameters for each httpRequest.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          This is applied last via merging with Object.assign() and overwrites other values set from other sources.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          new Client({
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            requestHandler: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              requestInit(httpRequest) {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                return { cache: "no-store" };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          });
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          requestTimeout?: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The number of milliseconds a request can take before being automatically +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          requestTimeout?: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The number of milliseconds a request can take before being automatically terminated.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/interfaces/_internal_.FinalizeHandler.html b/docs/interfaces/_internal_.FinalizeHandler.html index 0b2f837b..1eedc96d 100644 --- a/docs/interfaces/_internal_.FinalizeHandler.html +++ b/docs/interfaces/_internal_.FinalizeHandler.html @@ -1,4 +1,4 @@ FinalizeHandler | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Interface FinalizeHandler<Input, Output>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Input extends object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Output extends object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns Promise<FinalizeHandlerOutput<Output>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/interfaces/_internal_.FinalizeHandlerArguments.html b/docs/interfaces/_internal_.FinalizeHandlerArguments.html index 7596341c..a1462173 100644 --- a/docs/interfaces/_internal_.FinalizeHandlerArguments.html +++ b/docs/interfaces/_internal_.FinalizeHandlerArguments.html @@ -1,6 +1,6 @@ -FinalizeHandlerArguments | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              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.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                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.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                request: unknown

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                The user input serialized as a request.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                request: unknown

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                The user input serialized as a request.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/interfaces/_internal_.FinalizeHandlerOutput.html b/docs/interfaces/_internal_.FinalizeHandlerOutput.html index b902f12e..516aaebc 100644 --- a/docs/interfaces/_internal_.FinalizeHandlerOutput.html +++ b/docs/interfaces/_internal_.FinalizeHandlerOutput.html @@ -1,8 +1,8 @@ -FinalizeHandlerOutput | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  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.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    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 response, you need to guard its type to e.g. HttpResponse with 'instanceof' operand.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    During the deserialize phase of the execution of a middleware stack, a deserialized response may or may not be available

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/interfaces/_internal_.FlexibleChecksumsInputConfig.html b/docs/interfaces/_internal_.FlexibleChecksumsInputConfig.html index 4b8fb2db..81e86347 100644 --- a/docs/interfaces/_internal_.FlexibleChecksumsInputConfig.html +++ b/docs/interfaces/_internal_.FlexibleChecksumsInputConfig.html @@ -2,7 +2,7 @@ requestStreamBufferSize? responseChecksumValidation?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    requestChecksumCalculation?:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | RequestChecksumCalculation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | Provider<RequestChecksumCalculation>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Determines when a checksum will be calculated for request payloads.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    requestStreamBufferSize?: number | false

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Default 0 (off).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    requestStreamBufferSize?: number | false

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Default 0 (off).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    When set to a value greater than or equal to 8192, sets the minimum number of bytes to buffer into a chunk when processing input streams with chunked encoding (that is, when request checksums are enabled). @@ -12,5 +12,5 @@ your input stream. You do not need to set this value if your stream already flows chunks of 8kb or greater.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    responseChecksumValidation?:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | ResponseChecksumValidation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | Provider<ResponseChecksumValidation>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Determines when checksum validation will be performed on response payloads.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    responseChecksumValidation?:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | ResponseChecksumValidation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | Provider<ResponseChecksumValidation>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Determines when checksum validation will be performed on response payloads.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/interfaces/_internal_.Float16Array.html b/docs/interfaces/_internal_.Float16Array.html index f37f5659..cdf055f7 100644 --- a/docs/interfaces/_internal_.Float16Array.html +++ b/docs/interfaces/_internal_.Float16Array.html @@ -1,6 +1,6 @@ Float16Array | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Interface Float16Array<TArrayBuffer>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      A typed array of 16-bit float values. The contents are initialized to 0. If the requested number of bytes could not be allocated an exception is raised.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      interface Float16Array<TArrayBuffer extends ArrayBufferLike = ArrayBufferLike> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "[toStringTag]": "Float16Array";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          buffer: TArrayBuffer;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          byteLength: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          byteOffset: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          BYTES_PER_ELEMENT: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          length: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "[iterator]"(): ArrayIterator<number>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          at(index: number): number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          copyWithin(target: number, start: number, end?: number): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          entries(): ArrayIterator<[number, number]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          every(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              predicate: (value: number, index: number, array: this) => unknown,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              thisArg?: any,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          fill(value: number, start?: number, end?: number): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          filter(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              predicate: (value: number, index: number, array: this) => any,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              thisArg?: any,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): Float16Array<ArrayBuffer>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          find(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              predicate: (value: number, index: number, obj: this) => boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              thisArg?: any,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          findIndex(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              predicate: (value: number, index: number, obj: this) => boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              thisArg?: any,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          findLast<S extends number>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              predicate: (value: number, index: number, array: this) => value is S,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              thisArg?: any,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): S;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          findLast(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              predicate: (value: number, index: number, array: this) => unknown,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              thisArg?: any,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          findLastIndex(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              predicate: (value: number, index: number, array: this) => unknown,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              thisArg?: any,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          forEach(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              callbackfn: (value: number, index: number, array: this) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              thisArg?: any,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          includes(searchElement: number, fromIndex?: number): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          indexOf(searchElement: number, fromIndex?: number): number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          join(separator?: string): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          keys(): ArrayIterator<number>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          lastIndexOf(searchElement: number, fromIndex?: number): number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          map(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              callbackfn: (value: number, index: number, array: this) => number,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              thisArg?: any,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): Float16Array<ArrayBuffer>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          reduce(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              callbackfn: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  previousValue: number,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  currentValue: number,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  currentIndex: number,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  array: this,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ) => number,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          reduce(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              callbackfn: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  previousValue: number,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  currentValue: number,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  currentIndex: number,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  array: this,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ) => number,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              initialValue: number,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          reduce<U>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              callbackfn: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  previousValue: U,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  currentValue: number,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  currentIndex: number,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  array: this,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ) => U,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              initialValue: U,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): U;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          reduceRight(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              callbackfn: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  previousValue: number,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  currentValue: number,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  currentIndex: number,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  array: this,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ) => number,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          reduceRight(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              callbackfn: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  previousValue: number,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  currentValue: number,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  currentIndex: number,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  array: this,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ) => number,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              initialValue: number,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          reduceRight<U>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              callbackfn: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  previousValue: U,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  currentValue: number,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  currentIndex: number,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  array: this,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ) => U,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              initialValue: U,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): U;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          reverse(): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          set(array: ArrayLike<number>, offset?: number): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          slice(start?: number, end?: number): Float16Array<ArrayBuffer>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          some(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              predicate: (value: number, index: number, array: this) => unknown,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              thisArg?: any,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          sort(compareFn?: (a: number, b: number) => number): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          subarray(begin?: number, end?: number): Float16Array<TArrayBuffer>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          toLocaleString(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              locales?: string | string[],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              options?: NumberFormatOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          toReversed(): Float16Array<ArrayBuffer>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          toSorted(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              compareFn?: (a: number, b: number) => number,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): Float16Array<ArrayBuffer>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          toString(): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          valueOf(): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          values(): ArrayIterator<number>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          with(index: number, value: number): Float16Array<ArrayBuffer>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          [index: number]: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [index: number]: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      [toStringTag] +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      interface Float16Array<TArrayBuffer extends ArrayBufferLike = ArrayBufferLike> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "[toStringTag]": "Float16Array";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          buffer: TArrayBuffer;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          byteLength: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          byteOffset: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          BYTES_PER_ELEMENT: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          length: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "[iterator]"(): ArrayIterator<number>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          at(index: number): number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          copyWithin(target: number, start: number, end?: number): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          entries(): ArrayIterator<[number, number]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          every(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              predicate: (value: number, index: number, array: this) => unknown,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              thisArg?: any,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          fill(value: number, start?: number, end?: number): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          filter(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              predicate: (value: number, index: number, array: this) => any,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              thisArg?: any,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): Float16Array<ArrayBuffer>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          find(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              predicate: (value: number, index: number, obj: this) => boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              thisArg?: any,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          findIndex(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              predicate: (value: number, index: number, obj: this) => boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              thisArg?: any,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          findLast<S extends number>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              predicate: (value: number, index: number, array: this) => value is S,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              thisArg?: any,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): S;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          findLast(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              predicate: (value: number, index: number, array: this) => unknown,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              thisArg?: any,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          findLastIndex(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              predicate: (value: number, index: number, array: this) => unknown,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              thisArg?: any,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          forEach(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              callbackfn: (value: number, index: number, array: this) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              thisArg?: any,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          includes(searchElement: number, fromIndex?: number): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          indexOf(searchElement: number, fromIndex?: number): number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          join(separator?: string): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          keys(): ArrayIterator<number>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          lastIndexOf(searchElement: number, fromIndex?: number): number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          map(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              callbackfn: (value: number, index: number, array: this) => number,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              thisArg?: any,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): Float16Array<ArrayBuffer>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          reduce(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              callbackfn: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  previousValue: number,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  currentValue: number,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  currentIndex: number,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  array: this,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ) => number,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          reduce(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              callbackfn: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  previousValue: number,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  currentValue: number,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  currentIndex: number,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  array: this,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ) => number,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              initialValue: number,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          reduce<U>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              callbackfn: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  previousValue: U,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  currentValue: number,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  currentIndex: number,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  array: this,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ) => U,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              initialValue: U,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): U;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          reduceRight(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              callbackfn: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  previousValue: number,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  currentValue: number,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  currentIndex: number,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  array: this,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ) => number,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          reduceRight(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              callbackfn: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  previousValue: number,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  currentValue: number,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  currentIndex: number,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  array: this,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ) => number,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              initialValue: number,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          reduceRight<U>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              callbackfn: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  previousValue: U,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  currentValue: number,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  currentIndex: number,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  array: this,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ) => U,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              initialValue: U,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): U;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          reverse(): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          set(array: ArrayLike<number>, offset?: number): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          slice(start?: number, end?: number): Float16Array<ArrayBuffer>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          some(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              predicate: (value: number, index: number, array: this) => unknown,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              thisArg?: any,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          sort(compareFn?: (a: number, b: number) => number): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          subarray(begin?: number, end?: number): Float16Array<TArrayBuffer>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          toLocaleString(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              locales?: string | string[],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              options?: NumberFormatOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          toReversed(): Float16Array<ArrayBuffer>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          toSorted(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              compareFn?: (a: number, b: number) => number,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): Float16Array<ArrayBuffer>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          toString(): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          valueOf(): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          values(): ArrayIterator<number>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          with(index: number, value: number): Float16Array<ArrayBuffer>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          [index: number]: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [index: number]: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      [toStringTag] buffer byteLength byteOffset @@ -40,156 +40,156 @@ values with

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "[toStringTag]": "Float16Array"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      buffer: TArrayBuffer

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The ArrayBuffer instance referenced by the array.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      byteLength: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The length in bytes of the array.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      byteOffset: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The offset in bytes of the array.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      BYTES_PER_ELEMENT: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The size in bytes of each element in the array.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      length: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The length of the array.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Returns ArrayIterator<number>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Returns the item located at the specified index.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      byteLength: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The length in bytes of the array.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      byteOffset: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The offset in bytes of the array.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      BYTES_PER_ELEMENT: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The size in bytes of each element in the array.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      length: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The length of the array.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Returns ArrayIterator<number>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Returns the item located at the specified index.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • index: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The zero-based index of the desired code unit. A negative index will count back from the last item.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Returns the this object after copying a section of the array identified by start and end +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • target: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          If target is negative, it is treated as length+target where length is the length of the array.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • start: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          If start is negative, it is treated as length+start. If end is negative, it +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • start: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Optionalend: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          If not specified, length of the this object is used as its default value.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Returns an array of key, value pairs for every entry in the array

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns ArrayIterator<[number, number]>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Determines whether all the members of an array satisfy the specified test.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Optionalend: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        If not specified, length of the this object is used as its default value.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Returns an array of key, value pairs for every entry in the array

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns ArrayIterator<[number, number]>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Determines whether all the members of an array satisfy the specified test.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • predicate: (value: number, index: number, array: this) => unknown

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • OptionalthisArg: any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          An object to which the this keyword can refer in the predicate function. +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • OptionalthisArg: any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Changes all array elements from start to end index to a static value and returns the modified array

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Changes all array elements from start to end index to a static value and returns the modified array

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • value: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          value to fill array section with

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Optionalstart: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          index to start filling the array at. If start is negative, it is treated as +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Optionalstart: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Optionalend: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          index to stop filling the array at. If end is negative, it is treated as +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Optionalend: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          index to stop filling the array at. If end is negative, it is treated as length+end.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Returns the elements of an array that meet the condition specified in a callback function.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Returns the elements of an array that meet the condition specified in a callback function.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • predicate: (value: number, index: number, array: this) => any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • OptionalthisArg: any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          An object to which the this keyword can refer in the predicate function. +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • OptionalthisArg: any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns Float16Array<ArrayBuffer>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Returns the value of the first element in the array where predicate is true, and undefined +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns Float16Array<ArrayBuffer>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • predicate: (value: number, index: number, obj: this) => boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • OptionalthisArg: any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          If provided, it will be used as the this value for each invocation of +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • OptionalthisArg: any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Returns the index of the first element in the array where predicate is true, and -1 +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • predicate: (value: number, index: number, obj: this) => boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • OptionalthisArg: any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          If provided, it will be used as the this value for each invocation of +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • OptionalthisArg: any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Returns the value of the last element in the array where predicate is true, and undefined +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Returns the value of the last element in the array where predicate is true, and undefined otherwise.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • S extends number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • predicate: (value: number, index: number, array: this) => value is S

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          findLast calls predicate once for each element of the array, in descending order, until it finds one where predicate returns true. If such an element is found, findLast immediately returns that element value. Otherwise, findLast returns undefined.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • OptionalthisArg: any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          If provided, it will be used as the this value for each invocation of +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • OptionalthisArg: any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns S

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • predicate: (value: number, index: number, array: this) => unknown
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • OptionalthisArg: any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Returns the index of the last element in the array where predicate is true, and -1 +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns S

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • predicate: (value: number, index: number, array: this) => unknown
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • OptionalthisArg: any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Returns the index of the last element in the array where predicate is true, and -1 otherwise.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • predicate: (value: number, index: number, array: this) => unknown

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          findLastIndex calls predicate once for each element of the array, in descending order, until it finds one where predicate returns true. If such an element is found, findLastIndex immediately returns that element index. Otherwise, findLastIndex returns -1.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • OptionalthisArg: any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          If provided, it will be used as the this value for each invocation of +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • OptionalthisArg: any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Performs the specified action for each element in an array.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Performs the specified action for each element in an array.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • callbackfn: (value: number, index: number, array: this) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • OptionalthisArg: any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          An object to which the this keyword can refer in the callbackfn function. +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • OptionalthisArg: any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Determines whether an array includes a certain element, returning true or false as appropriate.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Determines whether an array includes a certain element, returning true or false as appropriate.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • searchElement: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The element to search for.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • OptionalfromIndex: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The position in this array at which to begin searching for searchElement.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Returns the index of the first occurrence of a value in an array.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • OptionalfromIndex: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The position in this array at which to begin searching for searchElement.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Returns the index of the first occurrence of a value in an array.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • searchElement: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The value to locate in the array.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • OptionalfromIndex: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The array index at which to begin the search. If fromIndex is omitted, the +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • OptionalfromIndex: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Adds all the elements of an array separated by the specified separator string.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Adds all the elements of an array separated by the specified separator string.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Optionalseparator: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Returns an list of keys in the array

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns ArrayIterator<number>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Returns the index of the last occurrence of a value in an array.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Returns an list of keys in the array

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns ArrayIterator<number>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Returns the index of the last occurrence of a value in an array.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • searchElement: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The value to locate in the array.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • OptionalfromIndex: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The array index at which to begin the search. If fromIndex is omitted, the +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • OptionalfromIndex: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Calls a defined callback function on each element of an array, and returns an array that +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Calls a defined callback function on each element of an array, and returns an array that contains the results.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • callbackfn: (value: number, index: number, array: this) => number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • OptionalthisArg: any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          An object to which the this keyword can refer in the callbackfn function. +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • OptionalthisArg: any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns Float16Array<ArrayBuffer>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Calls the specified callback function for all the elements in an array. The return value of +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns Float16Array<ArrayBuffer>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • callbackfn: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              previousValue: number,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              currentValue: number,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              currentIndex: number,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              array: this,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ) => number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • callbackfn: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              previousValue: number,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              currentValue: number,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              currentIndex: number,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              array: this,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ) => number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • initialValue: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Calls the specified callback function for all the elements in an array. The return value of +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • callbackfn: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            previousValue: number,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            currentValue: number,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            currentIndex: number,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            array: this,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ) => number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • initialValue: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • U

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • callbackfn: (previousValue: U, currentValue: number, currentIndex: number, array: this) => U

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • initialValue: U

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        If initialValue is specified, it is used as the initial value to start +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • initialValue: U

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns U

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Calls the specified callback function for all the elements in an array, in descending order. +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns U

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • callbackfn: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              previousValue: number,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              currentValue: number,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              currentIndex: number,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              array: this,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ) => number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • callbackfn: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              previousValue: number,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              currentValue: number,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              currentIndex: number,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              array: this,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ) => number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • initialValue: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Calls the specified callback function for all the elements in an array, in descending order. +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • callbackfn: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            previousValue: number,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            currentValue: number,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            currentIndex: number,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            array: this,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ) => number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • initialValue: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • U

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • callbackfn: (previousValue: U, currentValue: number, currentIndex: number, array: this) => U

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • initialValue: U

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        If initialValue is specified, it is used as the initial value to start +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • initialValue: U

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns U

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Reverses the elements in an Array.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Sets a value or an array of values.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns U

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Reverses the elements in an Array.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Sets a value or an array of values.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • array: ArrayLike<number>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          A typed or untyped array of values to set.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Optionaloffset: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The index in the current array at which the values are to be written.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Returns a section of an array.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Optionaloffset: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The index in the current array at which the values are to be written.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Returns a section of an array.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Optionalstart: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The beginning of the specified portion of the array.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Optionalend: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The end of the specified portion of the array. This is exclusive of the element at the index 'end'.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns Float16Array<ArrayBuffer>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Determines whether the specified callback function returns true for any element of an array.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Optionalend: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The end of the specified portion of the array. This is exclusive of the element at the index 'end'.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns Float16Array<ArrayBuffer>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Determines whether the specified callback function returns true for any element of an array.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • predicate: (value: number, index: number, array: this) => unknown

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          A function that accepts up to three arguments. The some method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value true, or until the end of the array.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • OptionalthisArg: any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          An object to which the this keyword can refer in the predicate function. +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • OptionalthisArg: any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Sorts an array.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Sorts an array.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • OptionalcompareFn: (a: number, b: number) => number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function used to determine the order of the elements. It is expected to return a negative value if first argument is less than second argument, zero if they're equal and a positive value otherwise. If omitted, the elements are sorted in ascending order.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          [11,2,22,1].sort((a, b) => a - b)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Gets a new Float16Array view of the ArrayBuffer store for this array, referencing the elements +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Gets a new Float16Array view of the ArrayBuffer store for this array, referencing the elements at begin, inclusive, up to end, exclusive.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Optionalbegin: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The index of the beginning of the array.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Optionalend: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The index of the end of the array.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns Float16Array<TArrayBuffer>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Converts a number to a string by using the current locale.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Optionallocales: string | string[]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Optionaloptions: NumberFormatOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Copies the array and returns the copy with the elements in reverse order.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns Float16Array<ArrayBuffer>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Copies and sorts the array.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Optionalend: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The index of the end of the array.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns Float16Array<TArrayBuffer>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Converts a number to a string by using the current locale.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Optionallocales: string | string[]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Optionaloptions: NumberFormatOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Copies the array and returns the copy with the elements in reverse order.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns Float16Array<ArrayBuffer>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Copies and sorts the array.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • OptionalcompareFn: (a: number, b: number) => number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function used to determine the order of the elements. It is expected to return a negative value if the first argument is less than the second argument, zero if they're equal, and a positive value otherwise. If omitted, the elements are sorted in ascending order.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          const myNums = Float16Array.from([11.25, 2, -22.5, 1]);
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          myNums.toSorted((a, b) => a - b) // Float16Array(4) [-22.5, 1, 2, 11.5]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns Float16Array<ArrayBuffer>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Returns a string representation of an array.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Returns the primitive value of the specified object.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Returns an list of values in the array

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns ArrayIterator<number>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Copies the array and inserts the given number at the provided index.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns Float16Array<ArrayBuffer>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Returns a string representation of an array.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Returns the primitive value of the specified object.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Returns an list of values in the array

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns ArrayIterator<number>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Copies the array and inserts the given number at the provided index.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • index: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The index of the value to overwrite. If the index is negative, then it replaces from the end of the array.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • value: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The value to insert into the copied array.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns Float16Array<ArrayBuffer>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        A copy of the original array with the inserted value.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • value: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The value to insert into the copied array.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Returns Float16Array<ArrayBuffer>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      A copy of the original array with the inserted value.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/interfaces/_internal_.Float16ArrayConstructor.html b/docs/interfaces/_internal_.Float16ArrayConstructor.html index 5f8b4572..30effe38 100644 --- a/docs/interfaces/_internal_.Float16ArrayConstructor.html +++ b/docs/interfaces/_internal_.Float16ArrayConstructor.html @@ -4,18 +4,18 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      from of

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      BYTES_PER_ELEMENT: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The size in bytes of each element in the array.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      prototype: Float16Array<ArrayBufferLike>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Creates an array from an array-like or iterable object.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      prototype: Float16Array<ArrayBufferLike>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Creates an array from an array-like or iterable object.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • arrayLike: ArrayLike<number>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          An array-like object to convert to an array.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns Float16Array<ArrayBuffer>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Creates an array from an array-like or iterable object.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns Float16Array<ArrayBuffer>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Creates an array from an array-like or iterable object.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • arrayLike: ArrayLike<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        An array-like object to convert to an array.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • mapfn: (v: T, k: number) => number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        A mapping function to call on every element of the array.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • OptionalthisArg: any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Value of 'this' used to invoke the mapfn.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns Float16Array<ArrayBuffer>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Creates an array from an array-like or iterable object.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • mapfn: (v: T, k: number) => number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      A mapping function to call on every element of the array.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • OptionalthisArg: any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Value of 'this' used to invoke the mapfn.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Returns Float16Array<ArrayBuffer>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Creates an array from an array-like or iterable object.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • elements: Iterable<number>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        An iterable object to convert to an array.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns Float16Array<ArrayBuffer>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Creates an array from an array-like or iterable object.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Returns Float16Array<ArrayBuffer>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Creates an array from an array-like or iterable object.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • elements: Iterable<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        An iterable object to convert to an array.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Optionalmapfn: (v: T, k: number) => number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        A mapping function to call on every element of the array.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • OptionalthisArg: any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Value of 'this' used to invoke the mapfn.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns Float16Array<ArrayBuffer>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Returns a new array from a set of elements.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Optionalmapfn: (v: T, k: number) => number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        A mapping function to call on every element of the array.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • OptionalthisArg: any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Value of 'this' used to invoke the mapfn.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns Float16Array<ArrayBuffer>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Returns a new array from a set of elements.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • ...items: number[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          A set of elements to include in the new array object.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns Float16Array<ArrayBuffer>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Constructors
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns Float16Array<ArrayBuffer>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Constructors
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/interfaces/_internal_.Generator.html b/docs/interfaces/_internal_.Generator.html new file mode 100644 index 00000000..6643b5a5 --- /dev/null +++ b/docs/interfaces/_internal_.Generator.html @@ -0,0 +1,6 @@ +Generator | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        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 +throw +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/interfaces/_internal_.GetAllOptions.html b/docs/interfaces/_internal_.GetAllOptions.html index e81b7d3d..7e79045a 100644 --- a/docs/interfaces/_internal_.GetAllOptions.html +++ b/docs/interfaces/_internal_.GetAllOptions.html @@ -1,4 +1,4 @@ -GetAllOptions | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          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.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            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_.GetAwsChunkedEncodingStream.html b/docs/interfaces/_internal_.GetAwsChunkedEncodingStream.html index 540167f6..5d14209b 100644 --- a/docs/interfaces/_internal_.GetAwsChunkedEncodingStream.html +++ b/docs/interfaces/_internal_.GetAwsChunkedEncodingStream.html @@ -1,3 +1,3 @@ GetAwsChunkedEncodingStream | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Interface GetAwsChunkedEncodingStream<StreamType>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              A function that returns Readable Stream which follows aws-chunked encoding stream. It optionally adds checksum if options are provided.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • StreamType = any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • StreamType = any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/interfaces/_internal_.GetOperation.html b/docs/interfaces/_internal_.GetOperation.html index 7f98c331..138d103b 100644 --- a/docs/interfaces/_internal_.GetOperation.html +++ b/docs/interfaces/_internal_.GetOperation.html @@ -1,4 +1,4 @@ -GetOperation | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                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.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  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 6166b83a..eeb4d023 100644 --- a/docs/interfaces/_internal_.GetOptions.html +++ b/docs/interfaces/_internal_.GetOptions.html @@ -1,4 +1,4 @@ -GetOptions | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    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.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      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_.Hash.html b/docs/interfaces/_internal_.Hash.html index a7b3ff6c..5326915d 100644 --- a/docs/interfaces/_internal_.Hash.html +++ b/docs/interfaces/_internal_.Hash.html @@ -6,9 +6,9 @@ update

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Finalizes the hash and provides a promise that will be fulfilled with the raw bytes of the calculated hash.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns Promise<Uint8Array<ArrayBufferLike>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Adds a chunk of data to the hash. If a buffer is provided, the encoding +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns Promise<Uint8Array<ArrayBufferLike>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Adds a chunk of data to the hash. If a buffer is provided, the encoding argument will be ignored. If a string is provided without a specified encoding, implementations must assume UTF-8 encoding.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Not all encodings are supported on all platforms, though all must support UTF-8.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • toHash: SourceData
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Optionalencoding: "utf8" | "ascii" | "latin1"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • toHash: SourceData
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Optionalencoding: "utf8" | "ascii" | "latin1"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/interfaces/_internal_.HeaderObject.html b/docs/interfaces/_internal_.HeaderObject.html index 0cc20708..6b0d7f98 100644 --- a/docs/interfaces/_internal_.HeaderObject.html +++ b/docs/interfaces/_internal_.HeaderObject.html @@ -1,4 +1,4 @@ -HeaderObject | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        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.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          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 4588bdcc..7c176035 100644 --- a/docs/interfaces/_internal_.Headers.html +++ b/docs/interfaces/_internal_.Headers.html @@ -1,4 +1,4 @@ -Headers | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            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.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              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 @@ -9,4 +9,4 @@ keys set values -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              "[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>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              "[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>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/interfaces/_internal_.HttpAuthExtensionConfiguration.html b/docs/interfaces/_internal_.HttpAuthExtensionConfiguration.html index ce215275..974fc176 100644 --- a/docs/interfaces/_internal_.HttpAuthExtensionConfiguration.html +++ b/docs/interfaces/_internal_.HttpAuthExtensionConfiguration.html @@ -1,4 +1,4 @@ -HttpAuthExtensionConfiguration | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                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.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  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_.HttpAuthOption.html b/docs/interfaces/_internal_.HttpAuthOption.html index 32af52e3..6063f2b2 100644 --- a/docs/interfaces/_internal_.HttpAuthOption.html +++ b/docs/interfaces/_internal_.HttpAuthOption.html @@ -1,6 +1,6 @@ HttpAuthOption | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Interface HttpAuthOptionInternal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Interface that defines the identity and signing properties when selecting an HttpAuthScheme.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    interface HttpAuthOption {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        identityProperties?: Record<string, unknown>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        propertiesExtractor?: <
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            TConfig extends object,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            TContext extends HandlerExecutionContext,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        >(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            config: TConfig,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            context: TContext,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ) => {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            identityProperties?: Record<string, unknown>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            signingProperties?: Record<string, unknown>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        schemeId: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        signingProperties?: Record<string, unknown>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    identityProperties? +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    interface HttpAuthOption {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        identityProperties?: Record<string, unknown>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        propertiesExtractor?: <
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            TConfig extends object,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            TContext extends HandlerExecutionContext,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        >(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            config: TConfig,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            context: TContext,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ) => {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            identityProperties?: Record<string, unknown>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            signingProperties?: Record<string, unknown>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        schemeId: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        signingProperties?: Record<string, unknown>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    identityProperties? propertiesExtractor? schemeId signingProperties? diff --git a/docs/interfaces/_internal_.HttpAuthScheme.html b/docs/interfaces/_internal_.HttpAuthScheme.html index c7942481..9f76bde9 100644 --- a/docs/interfaces/_internal_.HttpAuthScheme.html +++ b/docs/interfaces/_internal_.HttpAuthScheme.html @@ -1,8 +1,8 @@ HttpAuthScheme | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Interface HttpAuthSchemeInternal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Interface that defines an HttpAuthScheme

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      interface HttpAuthScheme {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          schemeId: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          signer: HttpSigner;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          identityProvider(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              config: IdentityProviderConfig,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): IdentityProvider<Identity>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      schemeId +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      interface HttpAuthScheme {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          schemeId: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          signer: HttpSigner;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          identityProvider(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              config: IdentityProviderConfig,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): IdentityProvider<Identity>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      schemeId signer

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      identityProvider

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      schemeId: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ID for an HttpAuthScheme, typically the absolute shape ID of a Smithy auth trait.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      signer: HttpSigner

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      HttpSigner corresponding to an HttpAuthScheme.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      signer: HttpSigner

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      HttpSigner corresponding to an HttpAuthScheme.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/interfaces/_internal_.HttpAuthSchemeInputConfig.html b/docs/interfaces/_internal_.HttpAuthSchemeInputConfig.html index 09a1fb3c..5417f0c5 100644 --- a/docs/interfaces/_internal_.HttpAuthSchemeInputConfig.html +++ b/docs/interfaces/_internal_.HttpAuthSchemeInputConfig.html @@ -1,4 +1,4 @@ -HttpAuthSchemeInputConfig | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Interface HttpAuthSchemeInputConfigInternal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        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.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          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? @@ -11,16 +11,16 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          A comma-separated list of case-sensitive auth scheme names. An auth scheme name is a fully qualified auth scheme ID with the namespace prefix trimmed. For example, the auth scheme with ID aws.auth#sigv4 is named sigv4.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          credentials?: AwsCredentialIdentity | AwsCredentialIdentityProvider

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The credentials used to sign requests.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          httpAuthSchemeProvider?: S3HttpAuthSchemeProvider

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Configuration of an HttpAuthSchemeProvider for a client which resolves which HttpAuthScheme to use.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          httpAuthSchemes?: HttpAuthScheme[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Configuration of HttpAuthSchemes for a client which provides default identity providers and signers per auth scheme.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          signer?: RequestSigner | ((authScheme?: AuthScheme) => Promise<RequestSigner>)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The signer to use when signing requests.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          signerConstructor?: new (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              options: SignatureV4Init & SignatureV4CryptoInit,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ) => RequestSigner

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The injectable SigV4-compatible signer class constructor. If not supplied, +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          credentials?: AwsCredentialIdentity | AwsCredentialIdentityProvider

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The credentials used to sign requests.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          httpAuthSchemeProvider?: S3HttpAuthSchemeProvider

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Configuration of an HttpAuthSchemeProvider for a client which resolves which HttpAuthScheme to use.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          httpAuthSchemes?: HttpAuthScheme[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Configuration of HttpAuthSchemes for a client which provides default identity providers and signers per auth scheme.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          signer?: RequestSigner | ((authScheme?: AuthScheme) => Promise<RequestSigner>)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The signer to use when signing requests.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          signerConstructor?: new (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              options: SignatureV4Init & SignatureV4CryptoInit,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ) => RequestSigner

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The injectable SigV4-compatible signer class constructor. If not supplied, regular SignatureV4 constructor will be used.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          signingEscapePath?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Whether to escape request path when signing the request.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          signingRegion?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The region where you want to sign your request against. This +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          signingEscapePath?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Whether to escape request path when signing the request.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          signingRegion?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The region where you want to sign your request against. This can be different to the region in the endpoint.

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          This option will override the AWS sigv4a +

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

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The lookup order is:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            @@ -30,5 +30,5 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          1. signingRegionSet given by endpoint resolution.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          2. the singular region of the SDK client.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          systemClockOffset?: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          An offset value in milliseconds to apply to all signing times.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          systemClockOffset?: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          An offset value in milliseconds to apply to all signing times.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/interfaces/_internal_.HttpAuthSchemeParameters.html b/docs/interfaces/_internal_.HttpAuthSchemeParameters.html index 80fffab6..4c45e381 100644 --- a/docs/interfaces/_internal_.HttpAuthSchemeParameters.html +++ b/docs/interfaces/_internal_.HttpAuthSchemeParameters.html @@ -1,2 +1,2 @@ -HttpAuthSchemeParameters | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Interface HttpAuthSchemeParametersInternal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            interface HttpAuthSchemeParameters {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                operation?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            operation? +HttpAuthSchemeParameters | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              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 54ebf0f6..c91c3b6b 100644 --- a/docs/interfaces/_internal_.HttpAuthSchemeProvider.html +++ b/docs/interfaces/_internal_.HttpAuthSchemeProvider.html @@ -1 +1 @@ -HttpAuthSchemeProvider | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Interface HttpAuthSchemeProvider<TParameters>Internal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +HttpAuthSchemeProvider | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  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 a3b82cf7..4eacee4a 100644 --- a/docs/interfaces/_internal_.HttpHandlerExtensionConfiguration.html +++ b/docs/interfaces/_internal_.HttpHandlerExtensionConfiguration.html @@ -1,4 +1,4 @@ -HttpHandlerExtensionConfiguration | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    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.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      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_.HttpHandlerOptions.html b/docs/interfaces/_internal_.HttpHandlerOptions.html index dd48ca2c..d162412c 100644 --- a/docs/interfaces/_internal_.HttpHandlerOptions.html +++ b/docs/interfaces/_internal_.HttpHandlerOptions.html @@ -1,6 +1,6 @@ HttpHandlerOptions | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Interface HttpHandlerOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Represents the options that may be passed to an Http Handler.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        interface HttpHandlerOptions {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            abortSignal?: AbortSignal | AbortSignal;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            requestTimeout?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        abortSignal? +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        interface HttpHandlerOptions {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            abortSignal?: AbortSignal | AbortSignal;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            requestTimeout?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        abortSignal? requestTimeout?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        abortSignal?: AbortSignal | AbortSignal
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        requestTimeout?: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The maximum time in milliseconds that the connection phase of a request may take before the connection attempt is abandoned.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/interfaces/_internal_.HttpMessage.html b/docs/interfaces/_internal_.HttpMessage.html index fa0c0242..4c68331f 100644 --- a/docs/interfaces/_internal_.HttpMessage.html +++ b/docs/interfaces/_internal_.HttpMessage.html @@ -1,5 +1,5 @@ HttpMessage | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          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 a0d81848..b39b485f 100644 --- a/docs/interfaces/_internal_.HttpRequest.html +++ b/docs/interfaces/_internal_.HttpRequest.html @@ -1,6 +1,6 @@ HttpRequest | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            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 @@ -11,4 +11,4 @@ protocol query? username? -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Optionalbody

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            body?: any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            fragment?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            headers: HeaderBag
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            hostname: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            method: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            password?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            path: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            port?: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            protocol: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            query?: QueryParameterBag
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            username?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Optionalbody

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            body?: any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            fragment?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            headers: HeaderBag
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            hostname: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            method: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            password?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            path: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            port?: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            protocol: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            query?: QueryParameterBag
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            username?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/interfaces/_internal_.HttpResponse.html b/docs/interfaces/_internal_.HttpResponse.html index 944be67e..6bb3bdd9 100644 --- a/docs/interfaces/_internal_.HttpResponse.html +++ b/docs/interfaces/_internal_.HttpResponse.html @@ -1,6 +1,6 @@ HttpResponse | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              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_.HttpSigner.html b/docs/interfaces/_internal_.HttpSigner.html index 1ee3096a..e774e203 100644 --- a/docs/interfaces/_internal_.HttpSigner.html +++ b/docs/interfaces/_internal_.HttpSigner.html @@ -1,15 +1,15 @@ HttpSigner | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Interface HttpSignerInternal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Interface to sign identity and signing properties.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                interface HttpSigner {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    errorHandler?: ErrorHandler;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    successHandler?: SuccessHandler;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    sign(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        httpRequest: HttpRequest,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        identity: Identity,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        signingProperties: Record<string, unknown>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<HttpRequest>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                errorHandler? +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                interface HttpSigner {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    errorHandler?: ErrorHandler;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    successHandler?: SuccessHandler;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    sign(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        httpRequest: HttpRequest,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        identity: Identity,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        signingProperties: Record<string, unknown>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<HttpRequest>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                errorHandler? successHandler?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                sign

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                errorHandler?: ErrorHandler

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Handler that executes after the HttpSigner.sign invocation and corresponding middleware throws an error. The error handler is expected to throw the error it receives, so the return type of the error handler is never.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                successHandler?: SuccessHandler

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Handler that executes after the HttpSigner.sign invocation and corresponding +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                successHandler?: SuccessHandler

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Handler that executes after the HttpSigner.sign invocation and corresponding middleware succeeds.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Signs an HttpRequest with an identity and signing properties.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Signs an HttpRequest with an identity and signing properties.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • httpRequest: HttpRequest

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    request to sign

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • identity: Identity

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    identity to sing the request with

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • signingProperties: Record<string, unknown>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    property bag for signing

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns Promise<HttpRequest>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  signed request in a promise

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • identity: Identity

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                identity to sing the request with

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • signingProperties: Record<string, unknown>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                property bag for signing

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Returns Promise<HttpRequest>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                signed request in a promise

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/interfaces/_internal_.Identity.html b/docs/interfaces/_internal_.Identity.html index f7198a6b..e4851a72 100644 --- a/docs/interfaces/_internal_.Identity.html +++ b/docs/interfaces/_internal_.Identity.html @@ -1,3 +1,3 @@ -Identity | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Interface Identity

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  interface Identity {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      expiration?: Date;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  expiration? +Identity | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    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
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/interfaces/_internal_.IdentityProviderConfig.html b/docs/interfaces/_internal_.IdentityProviderConfig.html index ffba9579..b6ac73ab 100644 --- a/docs/interfaces/_internal_.IdentityProviderConfig.html +++ b/docs/interfaces/_internal_.IdentityProviderConfig.html @@ -1,6 +1,6 @@ IdentityProviderConfig | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Interface IdentityProviderConfigInternal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Interface to get an IdentityProvider for a specified HttpAuthScheme

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      interface IdentityProviderConfig {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          getIdentityProvider(schemeId: string): IdentityProvider<Identity>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      getIdentityProvider +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      interface IdentityProviderConfig {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          getIdentityProvider(schemeId: string): IdentityProvider<Identity>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      getIdentityProvider

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Get the IdentityProvider for a specified HttpAuthScheme.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • schemeId: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          schemeId of the HttpAuthScheme

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns IdentityProvider<Identity>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        IdentityProvider or undefined if HttpAuthScheme is not found

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns IdentityProvider<Identity>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      IdentityProvider or undefined if HttpAuthScheme is not found

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/interfaces/_internal_.IncomingHttpHeaders.html b/docs/interfaces/_internal_.IncomingHttpHeaders.html index eaf903a1..40bae183 100644 --- a/docs/interfaces/_internal_.IncomingHttpHeaders.html +++ b/docs/interfaces/_internal_.IncomingHttpHeaders.html @@ -1,4 +1,4 @@ -IncomingHttpHeaders | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        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.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          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? @@ -66,4 +66,4 @@ via? warning? www-authenticate? -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Optionalcontent-disposition

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "content-disposition"?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Optionalcontent-encoding

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "content-encoding"?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Optionalcontent-language

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "content-language"?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Optionalcontent-length

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "content-length"?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Optionalcontent-location

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "content-location"?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Optionalcontent-range

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "content-range"?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Optionalcontent-type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          acceptaccept-encodingaccept-languageaccept-patchaccept-rangesaccess-control-allow-credentialsaccess-control-allow-headersaccess-control-allow-methodsaccess-control-allow-originaccess-control-expose-headersaccess-control-max-ageaccess-control-request-headersaccess-control-request-methodageallowalt-svcauthorizationcache-controlconnectioncontent-dispositioncontent-encodingcontent-languagecontent-lengthcontent-locationcontent-rangecontent-typecookiedateetagexpectexpiresforwardedfromhostif-matchif-modified-sinceif-none-matchif-unmodified-sincelast-modifiedlocationoriginpragmaproxy-authenticateproxy-authorizationpublic-key-pinsrangerefererretry-aftersec-fetch-destsec-fetch-modesec-fetch-sitesec-fetch-usersec-websocket-acceptsec-websocket-extensionssec-websocket-keysec-websocket-protocolsec-websocket-versionset-cookiestrict-transport-securitytktrailertransfer-encodingupgradeuser-agentvaryviawarningwww-authenticate
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Optionalcontent-disposition

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "content-disposition"?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Optionalcontent-encoding

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "content-encoding"?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Optionalcontent-language

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "content-language"?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Optionalcontent-length

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "content-length"?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Optionalcontent-location

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "content-location"?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Optionalcontent-range

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "content-range"?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Optionalcontent-type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          acceptaccept-encodingaccept-languageaccept-patchaccept-rangesaccess-control-allow-credentialsaccess-control-allow-headersaccess-control-allow-methodsaccess-control-allow-originaccess-control-expose-headersaccess-control-max-ageaccess-control-request-headersaccess-control-request-methodageallowalt-svcauthorizationcache-controlconnectioncontent-dispositioncontent-encodingcontent-languagecontent-lengthcontent-locationcontent-rangecontent-typecookiedateetagexpectexpiresforwardedfromhostif-matchif-modified-sinceif-none-matchif-unmodified-sincelast-modifiedlocationoriginpragmaproxy-authenticateproxy-authorizationpublic-key-pinsrangerefererretry-aftersec-fetch-destsec-fetch-modesec-fetch-sitesec-fetch-usersec-websocket-acceptsec-websocket-extensionssec-websocket-keysec-websocket-protocolsec-websocket-versionset-cookiestrict-transport-securitytktrailertransfer-encodingupgradeuser-agentvaryviawarningwww-authenticate
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/interfaces/_internal_.InfoObject.html b/docs/interfaces/_internal_.InfoObject.html index a99a422c..03f1cf5b 100644 --- a/docs/interfaces/_internal_.InfoObject.html +++ b/docs/interfaces/_internal_.InfoObject.html @@ -1,4 +1,4 @@ -InfoObject | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            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.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              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_.InformationEvent.html b/docs/interfaces/_internal_.InformationEvent.html index 92ccb33d..79396848 100644 --- a/docs/interfaces/_internal_.InformationEvent.html +++ b/docs/interfaces/_internal_.InformationEvent.html @@ -1,8 +1,8 @@ -InformationEvent | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Interface InformationEvent

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                interface InformationEvent {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    headers: IncomingHttpHeaders;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    httpVersion: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    httpVersionMajor: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    httpVersionMinor: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    rawHeaders: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    statusCode: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    statusMessage: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                headers +InformationEvent | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Interface InformationEvent

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  interface InformationEvent {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      headers: IncomingHttpHeaders;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      httpVersion: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      httpVersionMajor: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      httpVersionMinor: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      rawHeaders: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      statusCode: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      statusMessage: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  headers httpVersion httpVersionMajor httpVersionMinor rawHeaders statusCode statusMessage -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  headers: IncomingHttpHeaders
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  httpVersion: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  httpVersionMajor: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  httpVersionMinor: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  rawHeaders: string[]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  statusCode: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  statusMessage: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  headers: IncomingHttpHeaders
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  httpVersion: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  httpVersionMajor: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  httpVersionMinor: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  rawHeaders: string[]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  statusCode: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  statusMessage: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/interfaces/_internal_.InitializeHandlerArguments.html b/docs/interfaces/_internal_.InitializeHandlerArguments.html index 37fbe754..4c422ac9 100644 --- a/docs/interfaces/_internal_.InitializeHandlerArguments.html +++ b/docs/interfaces/_internal_.InitializeHandlerArguments.html @@ -1,4 +1,4 @@ -InitializeHandlerArguments | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    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.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      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
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/interfaces/_internal_.InitializeHandlerOutput.html b/docs/interfaces/_internal_.InitializeHandlerOutput.html index a9656e60..474544c2 100644 --- a/docs/interfaces/_internal_.InitializeHandlerOutput.html +++ b/docs/interfaces/_internal_.InitializeHandlerOutput.html @@ -1,8 +1,8 @@ -InitializeHandlerOutput | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        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.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          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 response, you need to guard its type to e.g. HttpResponse with 'instanceof' operand.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          During the deserialize phase of the execution of a middleware stack, a deserialized response may or may not be available

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/interfaces/_internal_.IpcSocketConnectOpts.html b/docs/interfaces/_internal_.IpcSocketConnectOpts.html index 5301cd5e..3fed651d 100644 --- a/docs/interfaces/_internal_.IpcSocketConnectOpts.html +++ b/docs/interfaces/_internal_.IpcSocketConnectOpts.html @@ -1,2 +1,2 @@ -IpcSocketConnectOpts | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Interface IpcSocketConnectOpts

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            interface IpcSocketConnectOpts {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                path: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            path -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            path: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +IpcSocketConnectOpts | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Interface IpcSocketConnectOpts

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              interface IpcSocketConnectOpts {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  path: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              path +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              path: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/interfaces/_internal_.Iterator.html b/docs/interfaces/_internal_.Iterator.html index 15891bc2..464ff2d5 100644 --- a/docs/interfaces/_internal_.Iterator.html +++ b/docs/interfaces/_internal_.Iterator.html @@ -1,4 +1,4 @@ -Iterator | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Interface Iterator<T, TReturn, TNext>

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • T
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • TReturn = any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • TNext = any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                next +Iterator | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Interface Iterator<T, TReturn, TNext>

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • T
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • TReturn = any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • TNext = any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  next return? throw? -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/interfaces/_internal_.KeyObject.html b/docs/interfaces/_internal_.KeyObject.html index ce2e4f32..cc5b4e49 100644 --- a/docs/interfaces/_internal_.KeyObject.html +++ b/docs/interfaces/_internal_.KeyObject.html @@ -1,5 +1,5 @@ -KeyObject | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Interface KeyObject

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    interface KeyObject {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        passphrase?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        pem: string | Buffer<ArrayBufferLike>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    passphrase? +KeyObject | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Interface KeyObject

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      interface KeyObject {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          passphrase?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          pem: string | Buffer<ArrayBufferLike>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      passphrase? pem

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      passphrase?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Optional passphrase.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      pem: string | Buffer<ArrayBufferLike>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Private keys in PEM format.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      pem: string | Buffer<ArrayBufferLike>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Private keys in PEM format.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/interfaces/_internal_.LicenseObject.html b/docs/interfaces/_internal_.LicenseObject.html index db0b7d7d..3e41bf05 100644 --- a/docs/interfaces/_internal_.LicenseObject.html +++ b/docs/interfaces/_internal_.LicenseObject.html @@ -1,4 +1,4 @@ -LicenseObject | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        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.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          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 4fcdfbd9..5ebdb109 100644 --- a/docs/interfaces/_internal_.LinkObject.html +++ b/docs/interfaces/_internal_.LinkObject.html @@ -1,4 +1,4 @@ -LinkObject | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            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.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              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 new file mode 100644 index 00000000..1dca7f24 --- /dev/null +++ b/docs/interfaces/_internal_.ListSchema.html @@ -0,0 +1,7 @@ +ListSchema | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                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 +namespace +traits +valueSchema +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                name: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                namespace: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                traits: SchemaTraits
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                valueSchema: SchemaRef

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/interfaces/_internal_.Logger.html b/docs/interfaces/_internal_.Logger.html index 7b850e11..edfb9899 100644 --- a/docs/interfaces/_internal_.Logger.html +++ b/docs/interfaces/_internal_.Logger.html @@ -1,6 +1,6 @@ Logger | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Interface Logger

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Represents a logger object that is available in HandlerExecutionContext throughout the middleware stack.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  interface Logger {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      debug: (...content: any[]) => void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      error: (...content: any[]) => void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      info: (...content: any[]) => void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      trace?: (...content: any[]) => void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      warn: (...content: any[]) => void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  debug +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  interface Logger {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      debug: (...content: any[]) => void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      error: (...content: any[]) => void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      info: (...content: any[]) => void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      trace?: (...content: any[]) => void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      warn: (...content: any[]) => void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  debug error info trace? diff --git a/docs/interfaces/_internal_.LookupAddress.html b/docs/interfaces/_internal_.LookupAddress.html index 7cf5fef9..5778f13a 100644 --- a/docs/interfaces/_internal_.LookupAddress.html +++ b/docs/interfaces/_internal_.LookupAddress.html @@ -1,6 +1,6 @@ LookupAddress | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Interface LookupAddress

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    interface LookupAddress {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        address: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        family: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    address family

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    address: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    A string representation of an IPv4 or IPv6 address.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    family: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    4 or 6, denoting the family of address, or 0 if the address is not an IPv4 or IPv6 address. 0 is a likely indicator of a +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    family: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    4 or 6, denoting the family of address, or 0 if the address is not an IPv4 or IPv6 address. 0 is a likely indicator of a bug in the name resolution service used by the operating system.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/interfaces/_internal_.LookupOptions.html b/docs/interfaces/_internal_.LookupOptions.html index eaec536a..c9438820 100644 --- a/docs/interfaces/_internal_.LookupOptions.html +++ b/docs/interfaces/_internal_.LookupOptions.html @@ -15,7 +15,7 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    hints?: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    One or more supported getaddrinfo flags. Multiple flags may be passed by bitwise ORing their values.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    order?: "ipv4first" | "ipv6first" | "verbatim"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    When verbatim, the resolved addresses are return unsorted. When ipv4first, the resolved addresses are sorted +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    order?: "ipv4first" | "ipv6first" | "verbatim"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    When verbatim, the resolved addresses are return unsorted. When ipv4first, the resolved addresses are sorted by placing IPv4 addresses before IPv6 addresses. When ipv6first, the resolved addresses are sorted by placing IPv6 addresses before IPv4 addresses. Default value is configurable using setDefaultResultOrder or --dns-result-order.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/interfaces/_internal_.MapSchema.html b/docs/interfaces/_internal_.MapSchema.html new file mode 100644 index 00000000..c7e26935 --- /dev/null +++ b/docs/interfaces/_internal_.MapSchema.html @@ -0,0 +1,8 @@ +MapSchema | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      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 +name +namespace +traits +valueSchema +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      keySchema: SchemaRef
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      name: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      namespace: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      traits: SchemaTraits
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      valueSchema: SchemaRef

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/interfaces/_internal_.MediaTypeObject.html b/docs/interfaces/_internal_.MediaTypeObject.html index ed6812de..afb64d53 100644 --- a/docs/interfaces/_internal_.MediaTypeObject.html +++ b/docs/interfaces/_internal_.MediaTypeObject.html @@ -1,4 +1,4 @@ -MediaTypeObject | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        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.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          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_.Message.html b/docs/interfaces/_internal_.Message.html index 50891dff..0d96ccdf 100644 --- a/docs/interfaces/_internal_.Message.html +++ b/docs/interfaces/_internal_.Message.html @@ -1,6 +1,6 @@ Message | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Interface Message

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            An event stream message. The headers and body properties will always be defined, with empty headers represented as an object with no keys and an empty body represented as a zero-length Uint8Array.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            interface Message {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                body: Uint8Array;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                headers: MessageHeaders;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            body +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            interface Message {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                body: Uint8Array;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                headers: MessageHeaders;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            body headers

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            body

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            body: Uint8Array
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            headers: MessageHeaders

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/interfaces/_internal_.MetadataBearer.html b/docs/interfaces/_internal_.MetadataBearer.html index 405691b5..099dd450 100644 --- a/docs/interfaces/_internal_.MetadataBearer.html +++ b/docs/interfaces/_internal_.MetadataBearer.html @@ -1,3 +1,3 @@ MetadataBearer | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Interface MetadataBearer

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              interface MetadataBearer {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  $metadata: ResponseMetadata;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              $metadata

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              $metadata: ResponseMetadata

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Metadata pertaining to this request.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/interfaces/_internal_.MoveOperation.html b/docs/interfaces/_internal_.MoveOperation.html index 5b019ba7..c1022491 100644 --- a/docs/interfaces/_internal_.MoveOperation.html +++ b/docs/interfaces/_internal_.MoveOperation.html @@ -1,4 +1,4 @@ -MoveOperation | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                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.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  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 e1a87f8c..8d62b8da 100644 --- a/docs/interfaces/_internal_.MultipleOptionalResolvedValueMetadataInjectOptions.html +++ b/docs/interfaces/_internal_.MultipleOptionalResolvedValueMetadataInjectOptions.html @@ -1,4 +1,4 @@ -MultipleOptionalResolvedValueMetadataInjectOptions | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    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.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      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 1a2a8730..779dcdc4 100644 --- a/docs/interfaces/_internal_.MultipleResolvedValueMetadataInjectOptions.html +++ b/docs/interfaces/_internal_.MultipleResolvedValueMetadataInjectOptions.html @@ -1,4 +1,4 @@ -MultipleResolvedValueMetadataInjectOptions | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        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.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          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_.NodeHttpHandlerOptions.html b/docs/interfaces/_internal_.NodeHttpHandlerOptions.html index ed53a5a9..126daf1d 100644 --- a/docs/interfaces/_internal_.NodeHttpHandlerOptions.html +++ b/docs/interfaces/_internal_.NodeHttpHandlerOptions.html @@ -1,25 +1,30 @@ NodeHttpHandlerOptions | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Interface NodeHttpHandlerOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Represents the http options that can be passed to a node http client.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            interface NodeHttpHandlerOptions {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                connectionTimeout?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                httpAgent?: Agent | AgentOptions;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                httpsAgent?: Agent | AgentOptions;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                logger?: Logger;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                requestTimeout?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                socketAcquisitionWarningTimeout?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                socketTimeout?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            connectionTimeout? +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            interface NodeHttpHandlerOptions {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                connectionTimeout?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                httpAgent?: Agent | AgentOptions;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                httpsAgent?: Agent | AgentOptions;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                logger?: Logger;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                requestTimeout?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                socketAcquisitionWarningTimeout?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                socketTimeout?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                throwOnRequestTimeout?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            connectionTimeout? httpAgent? httpsAgent? logger? requestTimeout? socketAcquisitionWarningTimeout? -socketTimeout? +socketTimeout? +throwOnRequestTimeout?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            connectionTimeout?: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The maximum time in milliseconds that the connection phase of a request -may take before the connection attempt is abandoned.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Defaults to 0, which disables the timeout.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            httpAgent?: Agent | AgentOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            You can pass http.Agent or its constructor options.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            httpsAgent?: Agent | AgentOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            You can pass https.Agent or its constructor options.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            logger?: Logger

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Optional logger.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            requestTimeout?: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The number of milliseconds a request can take before automatically being terminated. +may take before the connection attempt is abandoned. Defaults to 0, which disables the timeout.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            socketAcquisitionWarningTimeout?: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Delay before the NodeHttpHandler checks for socket exhaustion, +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            httpAgent?: Agent | AgentOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            You can pass http.Agent or its constructor options.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            httpsAgent?: Agent | AgentOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            You can pass https.Agent or its constructor options.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            logger?: Logger

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Optional logger.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            requestTimeout?: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The maximum number of milliseconds request & response should take. +Defaults to 0, which disables the timeout.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            If exceeded, a warning will be emitted unless throwOnRequestTimeout=true, +in which case a TimeoutError will be thrown.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            socketAcquisitionWarningTimeout?: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Delay before the NodeHttpHandler checks for socket exhaustion, and emits a warning if the active sockets and enqueued request count is greater than 2x the maxSockets count.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Defaults to connectionTimeout + requestTimeout or 3000ms if those are not set.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            socketTimeout?: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            This field is deprecated, and requestTimeout should be used instead. -The maximum time in milliseconds that a socket may remain idle before it -is closed.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Use requestTimeout

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            socketTimeout?: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The maximum time in milliseconds that a socket may remain idle before it +is closed. Defaults to 0, which means no maximum.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            This does not affect the server, which may still close the connection due to an idle socket.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            throwOnRequestTimeout?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Because requestTimeout was for a long time incorrectly being set as a socket idle timeout, +users must also opt-in for request timeout thrown errors. +Without this setting, a breach of the request timeout will be logged as a warning.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            On This Page

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Interface NormalizedSchema

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Normalization wrapper for various schema data objects.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              interface NormalizedSchema {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  getMemberSchema(member: string): NormalizedSchema;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  getMemberTraits(): SchemaTraitsObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  getMergedTraits(): SchemaTraitsObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  getName(): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  getOwnTraits(): SchemaTraitsObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  getSchema(): $Schema;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  getValueSchema(): NormalizedSchema;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  isBigDecimalSchema(): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  isBigIntegerSchema(): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  isBlobSchema(): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  isBooleanSchema(): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  isListSchema(): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  isMapSchema(): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  isMemberSchema(): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  isNumericSchema(): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  isStreaming(): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  isStringSchema(): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  isStructSchema(): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  isTimestampSchema(): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  structIterator(): Generator<
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      [string, NormalizedSchema],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      undefined,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      undefined,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  >;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              getMemberSchema +getMemberTraits +getMergedTraits +getName +getOwnTraits +getSchema +getValueSchema +isBigDecimalSchema +isBigIntegerSchema +isBlobSchema +isBooleanSchema +isListSchema +isMapSchema +isMemberSchema +isNumericSchema +isStreaming +isStringSchema +isStructSchema +isTimestampSchema +structIterator +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • For struct/union.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • member: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns NormalizedSchema

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Returns string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Returns $Schema

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/interfaces/_internal_.OAuthFlowObject.html b/docs/interfaces/_internal_.OAuthFlowObject.html index 72021659..59c0b1a7 100644 --- a/docs/interfaces/_internal_.OAuthFlowObject.html +++ b/docs/interfaces/_internal_.OAuthFlowObject.html @@ -1,4 +1,4 @@ -OAuthFlowObject | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                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.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  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 8bf1414f..aa5ad01d 100644 --- a/docs/interfaces/_internal_.OAuthFlowsObject.html +++ b/docs/interfaces/_internal_.OAuthFlowsObject.html @@ -1,4 +1,4 @@ -OAuthFlowsObject | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    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.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      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_.Object.html b/docs/interfaces/_internal_.Object.html index 16fbedee..3627e453 100644 --- a/docs/interfaces/_internal_.Object.html +++ b/docs/interfaces/_internal_.Object.html @@ -6,13 +6,13 @@ toString valueOf

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      constructor: Function

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The initial value of Object.prototype.constructor is the standard built-in Object constructor.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Determines whether an object has a property with the specified name.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Determines whether an object has a property with the specified name.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Determines whether an object exists in another object's prototype chain.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Determines whether an object exists in another object's prototype chain.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • v: Object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Another object whose prototype chain is to be checked.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Determines whether a specified property is enumerable.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Determines whether a specified property is enumerable.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Returns a date converted to a string using the current locale.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Returns a string representation of an object.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Returns the primitive value of the specified object.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns Object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Returns a date converted to a string using the current locale.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Returns a string representation of an object.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Returns the primitive value of the specified object.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns Object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/interfaces/_internal_.OnReadOpts.html b/docs/interfaces/_internal_.OnReadOpts.html index 8d860b65..b6bba090 100644 --- a/docs/interfaces/_internal_.OnReadOpts.html +++ b/docs/interfaces/_internal_.OnReadOpts.html @@ -1,6 +1,6 @@ -OnReadOpts | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Interface OnReadOpts

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        interface OnReadOpts {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            buffer: Uint8Array<ArrayBufferLike> | (() => Uint8Array);
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            callback(bytesWritten: number, buffer: Uint8Array): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        buffer +OnReadOpts | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Interface OnReadOpts

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          interface OnReadOpts {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              buffer: Uint8Array<ArrayBufferLike> | (() => Uint8Array);
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              callback(bytesWritten: number, buffer: Uint8Array): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          buffer

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          callback -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          buffer: Uint8Array<ArrayBufferLike> | (() => Uint8Array)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • This function is called for every chunk of incoming data. +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          buffer: Uint8Array<ArrayBufferLike> | (() => Uint8Array)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • This function is called for every chunk of incoming data. Two arguments are passed to it: the number of bytes written to buffer and a reference to buffer. Return false from this function to implicitly pause() the socket.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • bytesWritten: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • buffer: Uint8Array

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • bytesWritten: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • buffer: Uint8Array

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/interfaces/_internal_.OpenAPIObject.html b/docs/interfaces/_internal_.OpenAPIObject.html index 10345c98..e07c3556 100644 --- a/docs/interfaces/_internal_.OpenAPIObject.html +++ b/docs/interfaces/_internal_.OpenAPIObject.html @@ -1,4 +1,4 @@ -OpenAPIObject | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            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.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              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 bbd753e2..6dcbe434 100644 --- a/docs/interfaces/_internal_.OperationObject.html +++ b/docs/interfaces/_internal_.OperationObject.html @@ -1,4 +1,4 @@ -OperationObject | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                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.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  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_.OperationSchema.html b/docs/interfaces/_internal_.OperationSchema.html new file mode 100644 index 00000000..27581f75 --- /dev/null +++ b/docs/interfaces/_internal_.OperationSchema.html @@ -0,0 +1,8 @@ +OperationSchema | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Interface OperationSchemaInternal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Schema for an operation.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    use StaticOperationSchema or $OperationSchema

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    interface OperationSchema {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        input: SchemaRef;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        name: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        namespace: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        output: SchemaRef;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        traits: SchemaTraits;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    input +name +namespace +output +traits +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    input: SchemaRef
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    name: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    namespace: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    output: SchemaRef
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    traits: SchemaTraits

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/interfaces/_internal_.OptionalGetOptions.html b/docs/interfaces/_internal_.OptionalGetOptions.html index 031627d2..4ac92914 100644 --- a/docs/interfaces/_internal_.OptionalGetOptions.html +++ b/docs/interfaces/_internal_.OptionalGetOptions.html @@ -1,4 +1,4 @@ -OptionalGetOptions | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      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.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        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 23aabc96..b3e3fc28 100644 --- a/docs/interfaces/_internal_.OptionalResolvedValueMetadataInjectOptions.html +++ b/docs/interfaces/_internal_.OptionalResolvedValueMetadataInjectOptions.html @@ -1,4 +1,4 @@ -OptionalResolvedValueMetadataInjectOptions | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          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.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            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 4ff150cc..8bd4d82a 100644 --- a/docs/interfaces/_internal_.OutgoingHttpHeaders.html +++ b/docs/interfaces/_internal_.OutgoingHttpHeaders.html @@ -1,4 +1,4 @@ -OutgoingHttpHeaders | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              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.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                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? @@ -78,4 +78,4 @@ x-dns-prefetch-control? x-frame-options? x-xss-protection? -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                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[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Optionalcontent-disposition

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                "content-disposition"?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Optionalcontent-encoding

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                "content-encoding"?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Optionalcontent-language

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                "content-language"?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Optionalcontent-length

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                "content-length"?: string | number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Optionalcontent-location

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                "content-location"?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Optionalcontent-range

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                "content-range"?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Optionalcontent-security-policy

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                "content-security-policy"?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Optionalcontent-security-policy-report-only

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                "content-security-policy-report-only"?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Optionalcontent-type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                "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[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Optionalx-content-type-options

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                "x-content-type-options"?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                "x-dns-prefetch-control"?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                "x-frame-options"?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                "x-xss-protection"?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                acceptaccept-charsetaccept-encodingaccept-languageaccept-rangesaccess-control-allow-credentialsaccess-control-allow-headersaccess-control-allow-methodsaccess-control-allow-originaccess-control-expose-headersaccess-control-max-ageaccess-control-request-headersaccess-control-request-methodageallowauthorizationcache-controlcdn-cache-controlconnectioncontent-dispositioncontent-encodingcontent-languagecontent-lengthcontent-locationcontent-rangecontent-security-policycontent-security-policy-report-onlycontent-typecookiedatedavdntetagexpectexpiresforwardedfromhostif-matchif-modified-sinceif-none-matchif-rangeif-unmodified-sincelast-modifiedlinklocationmax-forwardsoriginpragmaproxy-authenticateproxy-authorizationpublic-key-pinspublic-key-pins-report-onlyrangerefererreferrer-policyrefreshretry-aftersec-websocket-acceptsec-websocket-extensionssec-websocket-keysec-websocket-protocolsec-websocket-versionserverset-cookiestrict-transport-securitytetrailertransfer-encodingupgradeupgrade-insecure-requestsuser-agentvaryviawarningwww-authenticatex-content-type-optionsx-dns-prefetch-controlx-frame-optionsx-xss-protection
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                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[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Optionalcontent-disposition

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                "content-disposition"?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Optionalcontent-encoding

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                "content-encoding"?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Optionalcontent-language

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                "content-language"?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Optionalcontent-length

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                "content-length"?: string | number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Optionalcontent-location

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                "content-location"?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Optionalcontent-range

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                "content-range"?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Optionalcontent-security-policy

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                "content-security-policy"?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Optionalcontent-security-policy-report-only

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                "content-security-policy-report-only"?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Optionalcontent-type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                "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[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Optionalx-content-type-options

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                "x-content-type-options"?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                "x-dns-prefetch-control"?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                "x-frame-options"?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                "x-xss-protection"?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                acceptaccept-charsetaccept-encodingaccept-languageaccept-rangesaccess-control-allow-credentialsaccess-control-allow-headersaccess-control-allow-methodsaccess-control-allow-originaccess-control-expose-headersaccess-control-max-ageaccess-control-request-headersaccess-control-request-methodageallowauthorizationcache-controlcdn-cache-controlconnectioncontent-dispositioncontent-encodingcontent-languagecontent-lengthcontent-locationcontent-rangecontent-security-policycontent-security-policy-report-onlycontent-typecookiedatedavdntetagexpectexpiresforwardedfromhostif-matchif-modified-sinceif-none-matchif-rangeif-unmodified-sincelast-modifiedlinklocationmax-forwardsoriginpragmaproxy-authenticateproxy-authorizationpublic-key-pinspublic-key-pins-report-onlyrangerefererreferrer-policyrefreshretry-aftersec-websocket-acceptsec-websocket-extensionssec-websocket-keysec-websocket-protocolsec-websocket-versionserverset-cookiestrict-transport-securitytetrailertransfer-encodingupgradeupgrade-insecure-requestsuser-agentvaryviawarningwww-authenticatex-content-type-optionsx-dns-prefetch-controlx-frame-optionsx-xss-protection
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/interfaces/_internal_.PSKCallbackNegotation.html b/docs/interfaces/_internal_.PSKCallbackNegotation.html index ed145c9d..17585379 100644 --- a/docs/interfaces/_internal_.PSKCallbackNegotation.html +++ b/docs/interfaces/_internal_.PSKCallbackNegotation.html @@ -1,3 +1,3 @@ -PSKCallbackNegotation | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Interface PSKCallbackNegotation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  interface PSKCallbackNegotation {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      identity: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      psk: DataView<ArrayBufferLike> | TypedArray<ArrayBufferLike>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  identity +PSKCallbackNegotation | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Interface PSKCallbackNegotation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    interface PSKCallbackNegotation {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        identity: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        psk: ArrayBufferView;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    identity psk -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    identity: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    psk: DataView<ArrayBufferLike> | TypedArray<ArrayBufferLike>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    identity: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    psk: ArrayBufferView

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/interfaces/_internal_.ParameterObject.html b/docs/interfaces/_internal_.ParameterObject.html index 340c1506..a8cf0d56 100644 --- a/docs/interfaces/_internal_.ParameterObject.html +++ b/docs/interfaces/_internal_.ParameterObject.html @@ -1,4 +1,4 @@ -ParameterObject | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      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.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        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 a8efc05f..cdf0a58f 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.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          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.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            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? @@ -18,23 +18,23 @@ toString

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            "[NODE_TYPE]": symbol
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            addToJSMap?: (ctx: ToJSContext, map: MapLike, value: unknown) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Customize the way that a key-value pair is resolved. Used for YAML 1.1 !!merge << handling.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            anchor?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            An optional anchor on this node. Used by alias nodes.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            comment?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            A comment on or immediately after this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            commentBefore?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            A comment before this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            format?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            By default (undefined), numbers use decimal notation. +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            anchor?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            An optional anchor on this node. Used by alias nodes.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            comment?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            A comment on or immediately after this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            commentBefore?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            A comment before this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            format?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            By default (undefined), numbers use decimal notation. The YAML 1.2 core schema only supports 'HEX' and 'OCT'. The YAML 1.1 schema also supports 'BIN' and 'TIME'

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            minFractionDigits?: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            If value is a number, use this value when stringifying this node.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            range: Range

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The [start, value-end, node-end] character offsets for the part of the +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            minFractionDigits?: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            If value is a number, use this value when stringifying this node.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            range: Range

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The [start, value-end, node-end] character offsets for the part of the source parsed into this node (undefined if not parsed). The value-end and node-end positions are themselves not included in their respective ranges.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            source: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Set during parsing to the source string value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            spaceBefore?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            A blank line before this node and its commentBefore

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            srcToken?: FlowScalar | BlockScalar

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The CST token that was composed into this node.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            tag?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            A fully qualified tag, if required

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            type?: Type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The scalar style used for the node's string representation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            value: unknown

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Create a copy of this node.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns NodeBase

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • A plain JavaScript representation of this node.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • A plain JS representation of this node

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Returns string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            source: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Set during parsing to the source string value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            spaceBefore?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            A blank line before this node and its commentBefore

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            srcToken?: FlowScalar | BlockScalar

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The CST token that was composed into this node.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            tag?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            A fully qualified tag, if required

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            type?: Type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The scalar style used for the node's string representation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            value: unknown

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Create a copy of this node.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns NodeBase

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • A plain JavaScript representation of this node.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • A plain JS representation of this node

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Returns string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/interfaces/_internal_.Parsed-2.html b/docs/interfaces/_internal_.Parsed-2.html index 29d6bf3f..f2e1880e 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.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              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.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                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? @@ -27,44 +27,44 @@ toString

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                "[NODE_TYPE]": symbol
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                addToJSMap?: (ctx: ToJSContext, map: MapLike, value: unknown) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Customize the way that a key-value pair is resolved. Used for YAML 1.1 !!merge << handling.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                anchor?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                An optional anchor on this node. Used by alias nodes.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                comment?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                A comment on or immediately after this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                commentBefore?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                A comment before this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                flow?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                If true, stringify this and all child nodes using flow rather than +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                anchor?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                An optional anchor on this node. Used by alias nodes.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                comment?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                A comment on or immediately after this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                commentBefore?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                A comment before this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                flow?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                If true, stringify this and all child nodes using flow rather than block styles.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                items: Pair<K, V>[]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                range: Range

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                The [start, value-end, node-end] character offsets for the part of the +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                items: Pair<K, V>[]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                range: Range

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                The [start, value-end, node-end] character offsets for the part of the source parsed into this node (undefined if not parsed). The value-end and node-end positions are themselves not included in their respective ranges.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                schema: Schema
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                spaceBefore?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                A blank line before this node and its commentBefore

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                srcToken?: BlockMap | FlowCollection

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                The CST token that was composed into this node.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                tag?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                A fully qualified tag, if required

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Adds a value to the collection.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                schema: Schema
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                spaceBefore?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                A blank line before this node and its commentBefore

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                srcToken?: BlockMap | FlowCollection

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                The CST token that was composed into this node.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                tag?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                A fully qualified tag, if required

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Adds a value to the collection.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • pair: Pair<K, V> | { key: K; value: V }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Optionaloverwrite: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    If not set true, using a key that is already in the collection will throw. Otherwise, overwrites the previous value.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Adds a value to the collection. For !!map and !!omap the value must +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Adds a value to the collection. For !!map and !!omap the value must be a Pair instance or a { key, value } object, which may not have a key that already exists in the map.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Create a copy of this collection.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Create a copy of this collection.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Optionalschema: Schema

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    If defined, overwrites the original's schema

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns Collection

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Removes a value from the collection.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns Collection

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Removes a value from the collection.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • key: unknown

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  true if the item was found and removed.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Removes a value from the collection.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Removes a value from the collection.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  true if the item was found and removed.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Returns item at key, or undefined if not found. By default unwraps +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Returns item at key, or undefined if not found. By default unwraps scalar values from their surrounding node; to disable set keepScalar to true (collections are always returned intact).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • key: unknown
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • keepScalar: true

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns Scalar<V>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • key: unknown
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • OptionalkeepScalar: false

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns V

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • key: unknown
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • OptionalkeepScalar: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns V | Scalar<V>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Returns item at key, or undefined if not found. By default unwraps +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • key: unknown
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • keepScalar: true

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns Scalar<V>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • key: unknown
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • OptionalkeepScalar: false

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns V

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • key: unknown
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • OptionalkeepScalar: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns V | Scalar<V>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Returns item at key, or undefined if not found. By default unwraps scalar values from their surrounding node; to disable set keepScalar to true (collections are always returned intact).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • path: Iterable<unknown>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • OptionalkeepScalar: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns unknown

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Checks if the collection includes a value with the key key.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • key: unknown

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • OptionalallowScalar: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Checks if the collection includes a value with the key key.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Sets a value in this collection. For !!set, value needs to be a +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • path: Iterable<unknown>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • OptionalkeepScalar: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns unknown

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Checks if the collection includes a value with the key key.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • key: unknown

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • OptionalallowScalar: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Checks if the collection includes a value with the key key.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Sets a value in this collection. For !!set, value needs to be a boolean to add/remove the item from the set.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • key: K
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • value: V

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Sets a value in this collection. For !!set, value needs to be a +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • key: K
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • value: V

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Sets a value in this collection. For !!set, value needs to be a boolean to add/remove the item from the set.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • A plain JavaScript representation of this node.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • T extends MapLike = Map<unknown, unknown>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Optional_: unknown
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Optionalctx: ToJSContext

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Conversion context, originally set in Document#toJS()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • OptionalType: new () => T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    If set, forces the returned collection type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Instance of Type, Map, or Object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Optionalctx: StringifyContext
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • OptionalonComment: () => void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • OptionalonChompKeep: () => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • A plain JavaScript representation of this node.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • T extends MapLike = Map<unknown, unknown>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Optional_: unknown
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Optionalctx: ToJSContext

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Conversion context, originally set in Document#toJS()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • OptionalType: new () => T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    If set, forces the returned collection type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Instance of Type, Map, or Object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Optionalctx: StringifyContext
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • OptionalonComment: () => void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • OptionalonChompKeep: () => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/interfaces/_internal_.Parsed-3.html b/docs/interfaces/_internal_.Parsed-3.html index 06e58ec2..70e6ab4f 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.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  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.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    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? @@ -27,58 +27,58 @@ toString

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "[NODE_TYPE]": symbol
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    addToJSMap?: (ctx: ToJSContext, map: MapLike, value: unknown) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Customize the way that a key-value pair is resolved. Used for YAML 1.1 !!merge << handling.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    anchor?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    An optional anchor on this node. Used by alias nodes.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    comment?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    A comment on or immediately after this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    commentBefore?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    A comment before this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    flow?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    If true, stringify this and all child nodes using flow rather than +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    anchor?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    An optional anchor on this node. Used by alias nodes.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    comment?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    A comment on or immediately after this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    commentBefore?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    A comment before this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    flow?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    If true, stringify this and all child nodes using flow rather than block styles.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    items: T[]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    range: Range

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The [start, value-end, node-end] character offsets for the part of the +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    items: T[]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    range: Range

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The [start, value-end, node-end] character offsets for the part of the source parsed into this node (undefined if not parsed). The value-end and node-end positions are themselves not included in their respective ranges.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    schema: Schema
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    spaceBefore?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    A blank line before this node and its commentBefore

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    srcToken?: BlockSequence | FlowCollection

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The CST token that was composed into this node.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    tag?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    A fully qualified tag, if required

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Adds a value to the collection.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • value: T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Adds a value to the collection. For !!map and !!omap the value must +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    schema: Schema
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    spaceBefore?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    A blank line before this node and its commentBefore

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    srcToken?: BlockSequence | FlowCollection

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The CST token that was composed into this node.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    tag?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    A fully qualified tag, if required

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Adds a value to the collection.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • value: T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Adds a value to the collection. For !!map and !!omap the value must be a Pair instance or a { key, value } object, which may not have a key that already exists in the map.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Create a copy of this collection.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Create a copy of this collection.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Optionalschema: Schema

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        If defined, overwrites the original's schema

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns Collection

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Removes a value from the collection.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns Collection

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Removes a value from the collection.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      key must contain a representation of an integer for this to succeed. It may be wrapped in a Scalar.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • key: unknown

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      true if the item was found and removed.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Removes a value from the collection.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Removes a value from the collection.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      true if the item was found and removed.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Returns item at key, or undefined if not found. By default unwraps +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Returns item at key, or undefined if not found. By default unwraps scalar values from their surrounding node; to disable set keepScalar to true (collections are always returned intact).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      key must contain a representation of an integer for this to succeed. It may be wrapped in a Scalar.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • key: unknown
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • keepScalar: true

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns Scalar<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Returns item at key, or undefined if not found. By default unwraps +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • key: unknown
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • keepScalar: true

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns Scalar<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Returns item at key, or undefined if not found. By default unwraps scalar values from their surrounding node; to disable set keepScalar to true (collections are always returned intact).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      key must contain a representation of an integer for this to succeed. It may be wrapped in a Scalar.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • key: unknown
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • OptionalkeepScalar: false

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Returns item at key, or undefined if not found. By default unwraps +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • key: unknown
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • OptionalkeepScalar: false

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Returns item at key, or undefined if not found. By default unwraps scalar values from their surrounding node; to disable set keepScalar to true (collections are always returned intact).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      key must contain a representation of an integer for this to succeed. It may be wrapped in a Scalar.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • key: unknown
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • OptionalkeepScalar: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns T | Scalar<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Returns item at key, or undefined if not found. By default unwraps +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • key: unknown
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • OptionalkeepScalar: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns T | Scalar<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Returns item at key, or undefined if not found. By default unwraps scalar values from their surrounding node; to disable set keepScalar to true (collections are always returned intact).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • path: Iterable<unknown>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • OptionalkeepScalar: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns unknown

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Checks if the collection includes a value with the key key.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • path: Iterable<unknown>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • OptionalkeepScalar: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns unknown

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Checks if the collection includes a value with the key key.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      key must contain a representation of an integer for this to succeed. It may be wrapped in a Scalar.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • key: unknown

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • OptionalallowScalar: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Checks if the collection includes a value with the key key.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Sets a value in this collection. For !!set, value needs to be a +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • key: unknown

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • OptionalallowScalar: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Checks if the collection includes a value with the key key.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Sets a value in this collection. For !!set, value needs to be a boolean to add/remove the item from the set.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      If key does not contain a representation of an integer, this will throw. It may be wrapped in a Scalar.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • key: unknown
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • value: T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Sets a value in this collection. For !!set, value needs to be a +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • key: unknown
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • value: T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Sets a value in this collection. For !!set, value needs to be a boolean to add/remove the item from the set.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • A plain JavaScript representation of this node.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • A plain JS representation of this node

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns unknown[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Optionalctx: StringifyContext
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • OptionalonComment: () => void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • OptionalonChompKeep: () => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • A plain JavaScript representation of this node.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • A plain JS representation of this node

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns unknown[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Optionalctx: StringifyContext
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • OptionalonComment: () => void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • OptionalonChompKeep: () => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/interfaces/_internal_.Parsed.html b/docs/interfaces/_internal_.Parsed.html index 9040c735..c0ba16a9 100644 --- a/docs/interfaces/_internal_.Parsed.html +++ b/docs/interfaces/_internal_.Parsed.html @@ -1,4 +1,4 @@ -Parsed | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      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.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        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? @@ -15,18 +15,18 @@ toString

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "[NODE_TYPE]": symbol
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        addToJSMap?: (ctx: ToJSContext, map: MapLike, value: unknown) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Customize the way that a key-value pair is resolved. Used for YAML 1.1 !!merge << handling.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        anchor?: never
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        comment?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        A comment on or immediately after this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        commentBefore?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        A comment before this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        range: Range

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The [start, value-end, node-end] character offsets for the part of the +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        anchor?: never
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        comment?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        A comment on or immediately after this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        commentBefore?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        A comment before this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        range: Range

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The [start, value-end, node-end] character offsets for the part of the source parsed into this node (undefined if not parsed). The value-end and node-end positions are themselves not included in their respective ranges.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        source: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        spaceBefore?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        A blank line before this node and its commentBefore

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        srcToken?: FlowScalar & { type: "alias" }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The CST token that was composed into this node.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        tag?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        A fully qualified tag, if required

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Create a copy of this node.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns NodeBase

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Resolve the value of this alias within doc, finding the last +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        source: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        spaceBefore?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        A blank line before this node and its commentBefore

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        srcToken?: FlowScalar & { type: "alias" }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The CST token that was composed into this node.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        tag?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        A fully qualified tag, if required

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Create a copy of this node.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns NodeBase

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • A plain JavaScript representation of this node.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • A plain JS representation of this node

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns unknown

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Optionalctx: StringifyContext
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Optional_onComment: () => void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Optional_onChompKeep: () => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns Scalar<unknown> | YAMLMap<unknown, unknown> | YAMLSeq<unknown>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • A plain JavaScript representation of this node.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • A plain JS representation of this node

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns unknown

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Optionalctx: StringifyContext
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Optional_onComment: () => void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Optional_onChompKeep: () => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/interfaces/_internal_.PathItemObject.html b/docs/interfaces/_internal_.PathItemObject.html index 4709da04..b63b538b 100644 --- a/docs/interfaces/_internal_.PathItemObject.html +++ b/docs/interfaces/_internal_.PathItemObject.html @@ -1,4 +1,4 @@ -PathItemObject | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          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.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            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 71b28863..153acfc3 100644 --- a/docs/interfaces/_internal_.PathsObject.html +++ b/docs/interfaces/_internal_.PathsObject.html @@ -1 +1 @@ -PathsObject | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Interface PathsObject

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +PathsObject | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                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 8cff0357..575d980f 100644 --- a/docs/interfaces/_internal_.PeerCertificate.html +++ b/docs/interfaces/_internal_.PeerCertificate.html @@ -1,4 +1,4 @@ -PeerCertificate | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  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?: Buffer;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      raw: Buffer;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      serialNumber: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      subject: Certificate;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      subjectaltname?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      valid_from: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      valid_to: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  asn1Curve? +PeerCertificate | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    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? @@ -22,29 +22,29 @@ While it is unusual, it is possible that the curve is identified by its mathematical properties, in which case it will not have an OID.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    bits?: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    For RSA keys: The RSA bit size.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    bits?: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    For RSA keys: The RSA bit size.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    For EC keys: The key size in bits.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ca: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    true if a Certificate Authority (CA), false otherwise.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ca: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    true if a Certificate Authority (CA), false otherwise.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    v18.13.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    exponent?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The RSA exponent, as a string in hexadecimal number notation.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ext_key_usage?: string[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The extended key usage, a set of OIDs.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    fingerprint: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The SHA-1 digest of the DER encoded certificate. +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    exponent?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The RSA exponent, as a string in hexadecimal number notation.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ext_key_usage?: string[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The extended key usage, a set of OIDs.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    fingerprint: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The SHA-1 digest of the DER encoded certificate. It is returned as a : separated hexadecimal string.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    fingerprint256: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The SHA-256 digest of the DER encoded certificate. +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    fingerprint256: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The SHA-256 digest of the DER encoded certificate. It is returned as a : separated hexadecimal string.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    fingerprint512: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The SHA-512 digest of the DER encoded certificate. +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    fingerprint512: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The SHA-512 digest of the DER encoded certificate. It is returned as a : separated hexadecimal string.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    infoAccess?: Dict<string[]>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    An array describing the AuthorityInfoAccess, used with OCSP.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    issuer: Certificate

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The certificate issuer, described in the same terms as the subject.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    modulus?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The RSA modulus, as a hexadecimal string.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    nistCurve?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The NIST name for the elliptic curve, if it has one +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    infoAccess?: Dict<string[]>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    An array describing the AuthorityInfoAccess, used with OCSP.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    issuer: Certificate

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The certificate issuer, described in the same terms as the subject.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    modulus?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The RSA modulus, as a hexadecimal string.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    nistCurve?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The NIST name for the elliptic curve, if it has one (not all well-known curves have been assigned names by NIST).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    pubkey?: Buffer

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The public key.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    raw: Buffer

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The DER encoded X.509 certificate data.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    serialNumber: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The certificate serial number, as a hex string.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    subject: Certificate

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The certificate subject.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    subjectaltname?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    A string containing concatenated names for the subject, +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    pubkey?: NonSharedBuffer

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The public key.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    raw: NonSharedBuffer

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The DER encoded X.509 certificate data.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    serialNumber: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The certificate serial number, as a hex string.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    subject: Certificate

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The certificate subject.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    subjectaltname?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    A string containing concatenated names for the subject, an alternative to the subject names.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    valid_from: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The date-time the certificate is valid from.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    valid_to: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The date-time the certificate is valid to.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    valid_from: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The date-time the certificate is valid from.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    valid_to: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The date-time the certificate is valid to.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    On This Page

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Interface ProcessEnv

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [key: string]: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      TZ? +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      TZ?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Can be used to change the default timezone at runtime

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/interfaces/_internal_.PromiseLike.html b/docs/interfaces/_internal_.PromiseLike.html index b7319a13..84212f86 100644 --- a/docs/interfaces/_internal_.PromiseLike.html +++ b/docs/interfaces/_internal_.PromiseLike.html @@ -1,6 +1,6 @@ PromiseLike | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Interface PromiseLike<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        interface PromiseLike<T> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            then<TResult1 = T, TResult2 = never>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                onfulfilled?: (value: T) => TResult1 | PromiseLike<TResult1>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                onrejected?: (reason: any) => TResult2 | PromiseLike<TResult2>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ): PromiseLike<TResult1 | TResult2>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • T
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        then

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Optionalonrejected: (reason: any) => TResult2 | PromiseLike<TResult2>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The callback to execute when the Promise is rejected.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Returns PromiseLike<TResult1 | TResult2>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        A Promise for the completion of which ever callback is executed.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/interfaces/_internal_.PropertyDescriptor.html b/docs/interfaces/_internal_.PropertyDescriptor.html index b8c1f29e..3a35f42e 100644 --- a/docs/interfaces/_internal_.PropertyDescriptor.html +++ b/docs/interfaces/_internal_.PropertyDescriptor.html @@ -1,7 +1,7 @@ -PropertyDescriptor | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Interface PropertyDescriptor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          interface PropertyDescriptor {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              configurable?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              enumerable?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              value?: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              writable?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              get(): any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              set(v: any): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          configurable? +PropertyDescriptor | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Interface PropertyDescriptor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            interface PropertyDescriptor {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                configurable?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                enumerable?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                value?: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                writable?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                get?(): any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                set?(v: any): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            configurable? enumerable? value? writable?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            get? set? -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            configurable?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            enumerable?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            value?: any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            writable?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Returns any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • v: any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            configurable?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            enumerable?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            value?: any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            writable?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Returns any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • v: any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/interfaces/_internal_.ProxyEnv.html b/docs/interfaces/_internal_.ProxyEnv.html new file mode 100644 index 00000000..752b437b --- /dev/null +++ b/docs/interfaces/_internal_.ProxyEnv.html @@ -0,0 +1,9 @@ +ProxyEnv | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Interface ProxyEnv

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [key: string]: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              http_proxy? +HTTP_PROXY? +https_proxy? +HTTPS_PROXY? +no_proxy? +NO_PROXY? +TZ? +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              http_proxy?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              HTTP_PROXY?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              https_proxy?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              HTTPS_PROXY?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              no_proxy?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              NO_PROXY?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              TZ?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Can be used to change the default timezone at runtime

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/interfaces/_internal_.PxfObject.html b/docs/interfaces/_internal_.PxfObject.html index fb3a1865..d1da9c00 100644 --- a/docs/interfaces/_internal_.PxfObject.html +++ b/docs/interfaces/_internal_.PxfObject.html @@ -1,5 +1,5 @@ -PxfObject | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Interface PxfObject

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                interface PxfObject {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    buf: string | Buffer<ArrayBufferLike>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    passphrase?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                buf +PxfObject | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Interface PxfObject

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  interface PxfObject {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      buf: string | Buffer<ArrayBufferLike>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      passphrase?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  buf passphrase?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  buf: string | Buffer<ArrayBufferLike>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  PFX or PKCS12 encoded private key and certificate chain.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  passphrase?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Optional passphrase.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  passphrase?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Optional passphrase.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/interfaces/_internal_.QueuingStrategy.html b/docs/interfaces/_internal_.QueuingStrategy.html index 6c34d4e4..851fba23 100644 --- a/docs/interfaces/_internal_.QueuingStrategy.html +++ b/docs/interfaces/_internal_.QueuingStrategy.html @@ -1,3 +1,3 @@ -QueuingStrategy | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Interface QueuingStrategy<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    interface QueuingStrategy<T = any> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        highWaterMark?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        size?: QueuingStrategySize<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • T = any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    highWaterMark? +QueuingStrategy | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Interface QueuingStrategy<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      interface QueuingStrategy<T = any> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          highWaterMark?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          size?: QueuingStrategySize<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • T = any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      highWaterMark? size? -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      highWaterMark?: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      size?: QueuingStrategySize<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      highWaterMark?: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      size?: QueuingStrategySize<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/interfaces/_internal_.QueuingStrategySize.html b/docs/interfaces/_internal_.QueuingStrategySize.html index 119907f6..ac8cdb87 100644 --- a/docs/interfaces/_internal_.QueuingStrategySize.html +++ b/docs/interfaces/_internal_.QueuingStrategySize.html @@ -1 +1 @@ -QueuingStrategySize | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Interface QueuingStrategySize<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • T = any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Optionalchunk: T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +QueuingStrategySize | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Interface QueuingStrategySize<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • T = any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Optionalchunk: T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/interfaces/_internal_.ReadOnlyDict.html b/docs/interfaces/_internal_.ReadOnlyDict.html index 23f9a907..1aaf5147 100644 --- a/docs/interfaces/_internal_.ReadOnlyDict.html +++ b/docs/interfaces/_internal_.ReadOnlyDict.html @@ -1 +1 @@ -ReadOnlyDict | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Interface ReadOnlyDict<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • readonly [key: string]: T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +ReadOnlyDict | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Interface ReadOnlyDict<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • readonly [key: string]: T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/interfaces/_internal_.ReadWriteStream.html b/docs/interfaces/_internal_.ReadWriteStream.html index 75ad7f1d..91bb206a 100644 --- a/docs/interfaces/_internal_.ReadWriteStream.html +++ b/docs/interfaces/_internal_.ReadWriteStream.html @@ -1,4 +1,4 @@ -ReadWriteStream | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                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.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  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]? @@ -28,38 +28,38 @@ unshift wrap write -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  readable: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  writable: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • K

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • error: Error
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • event: string | symbol
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • ...args: AnyRest

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Alias for emitter.on(eventName, listener).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  readable: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  writable: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • K

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • error: Error
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • event: string | symbol
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • ...args: AnyRest

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Alias for emitter.on(eventName, listener).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • K

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • eventName: string | symbol
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • listener: (...args: any[]) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    v0.1.26

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns true if the event had listeners, false otherwise.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    import { EventEmitter } from 'node:events';
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    const myEmitter = new EventEmitter();

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    // First listener
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    myEmitter.on('event', function firstListener() {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      console.log('Helloooo! first listener');
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    });
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    // Second listener
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    myEmitter.on('event', function secondListener(arg1, arg2) {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      console.log(`event with parameters ${arg1}, ${arg2} in second listener`);
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    });
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    // Third listener
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    myEmitter.on('event', function thirdListener(...args) {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      const parameters = args.join(', ');
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      console.log(`event with parameters ${parameters} in third listener`);
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    });

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    console.log(myEmitter.listeners('event'));

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    myEmitter.emit('event', 1, 2, 3, 4, 5);

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    // Prints:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    // [
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    //   [Function: firstListener],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    //   [Function: secondListener],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    //   [Function: thirdListener]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    // ]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    // Helloooo! first listener
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    // event with parameters 1, 2 in second listener
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    // event with parameters 1, 2, 3, 4, 5 in third listener

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • K

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • eventName: string | symbol
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • ...args: AnyRest

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    v0.1.26

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Optionalcb: () => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Returns an array listing the events for which the emitter has registered +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Optionalcb: () => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Returns an array listing the events for which the emitter has registered listeners. The values in the array are strings or Symbols.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    import { EventEmitter } from 'node:events';

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    const myEE = new EventEmitter();
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    myEE.on('foo', () => {});
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    myEE.on('bar', () => {});

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    const sym = Symbol('symbol');
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    myEE.on(sym, () => {});

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    console.log(myEE.eventNames());
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    // Prints: [ 'foo', 'bar', Symbol(symbol) ]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns (string | symbol)[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    v6.0.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Returns the current max listener value for the EventEmitter which is either +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Returns the current max listener value for the EventEmitter which is either set by emitter.setMaxListeners(n) or defaults to EventEmitter.defaultMaxListeners.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    v1.0.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Returns the number of listeners listening for the event named eventName. +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Returns the number of listeners listening for the event named eventName. If listener is provided, it will return how many times the listener is found in the list of the listeners of the event.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • K

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • eventName: string | symbol

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The name of the event being listened for

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Optionallistener: Function

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The event handler function

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    v3.2.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Returns a copy of the array of listeners for the event named eventName.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Optionallistener: Function

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The event handler function

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  v3.2.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Returns a copy of the array of listeners for the event named eventName.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    server.on('connection', (stream) => {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      console.log('someone connected!');
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    });
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    console.log(util.inspect(server.listeners('connection')));
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    // Prints: [ [Function] ]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • K

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • eventName: string | symbol

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns Function[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    v0.1.26

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Alias for emitter.removeListener().

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Alias for emitter.removeListener().

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • K

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • eventName: string | symbol
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • listener: (...args: any[]) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    v10.0.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Adds the listener function to the end of the listeners array for the event +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Adds the listener function to the end of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    @@ -73,9 +73,9 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • K

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • eventName: string | symbol

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The name of the event.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • listener: (...args: any[]) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The callback function

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    v0.1.101

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Adds a one-time listener function for the event named eventName. The +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • listener: (...args: any[]) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The callback function

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  v0.1.101

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Adds a one-time listener function for the event named eventName. The next time eventName is triggered, this listener is removed and then invoked.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    server.once('connection', (stream) => {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      console.log('Ah, we have our first user!');
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    });
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    @@ -87,9 +87,9 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • K

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • eventName: string | symbol

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The name of the event.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • listener: (...args: any[]) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The callback function

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    v0.3.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Returns this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • destination: T
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Optionaloptions: { end?: boolean }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Adds the listener function to the beginning of the listeners array for the +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • listener: (...args: any[]) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The callback function

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  v0.3.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Returns this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • destination: T
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Optionaloptions: { end?: boolean }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Adds the listener function to the beginning of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    @@ -98,30 +98,30 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns a reference to the EventEmitter, so that calls can be chained.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • K

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • eventName: string | symbol

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The name of the event.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • listener: (...args: any[]) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The callback function

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    v6.0.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Adds a one-timelistener function for the event named eventName to the beginning of the listeners array. The next time eventName is triggered, this +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • listener: (...args: any[]) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The callback function

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  v6.0.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Adds a one-timelistener function for the event named eventName to the beginning of the listeners array. The next time eventName is triggered, this listener is removed, and then invoked.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    server.prependOnceListener('connection', (stream) => {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      console.log('Ah, we have our first user!');
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    });

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns a reference to the EventEmitter, so that calls can be chained.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • K

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • eventName: string | symbol

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The name of the event.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • listener: (...args: any[]) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The callback function

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    v6.0.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Returns a copy of the array of listeners for the event named eventName, +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • listener: (...args: any[]) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The callback function

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  v6.0.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Returns a copy of the array of listeners for the event named eventName, including any wrappers (such as those created by .once()).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    import { EventEmitter } from 'node:events';
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    const emitter = new EventEmitter();
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    emitter.once('log', () => console.log('log once'));

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    // Returns a new Array with a function `onceWrapper` which has a property
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    // `listener` which contains the original listener bound above
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    const listeners = emitter.rawListeners('log');
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    const logFnWrapper = listeners[0];

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    // Logs "log once" to the console and does not unbind the `once` event
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    logFnWrapper.listener();

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    // Logs "log once" to the console and removes the listener
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    logFnWrapper();

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    emitter.on('log', () => console.log('log persistently'));
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    // Will return a new Array with a single function bound by `.on()` above
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    const newListeners = emitter.rawListeners('log');

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    // Logs "log persistently" twice
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    newListeners[0]();
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    emitter.emit('log');

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • K

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • eventName: string | symbol

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns Function[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    v9.4.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Removes all listeners, or those of the specified eventName.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Removes all listeners, or those of the specified eventName.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    It is bad practice to remove listeners added elsewhere in the code, particularly when the EventEmitter instance was created by some other component or module (e.g. sockets or file streams).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns a reference to the EventEmitter, so that calls can be chained.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • OptionaleventName: string | symbol

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    v0.1.26

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Removes the specified listener from the listener array for the event named eventName.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Removes the specified listener from the listener array for the event named eventName.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    const callback = (stream) => {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      console.log('someone connected!');
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    server.on('connection', callback);
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    // ...
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    server.removeListener('connection', callback);
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    @@ -148,10 +148,10 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns a reference to the EventEmitter, so that calls can be chained.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • K

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • eventName: string | symbol
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • listener: (...args: any[]) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    v0.1.26

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Returns this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • By default EventEmitters will print a warning if more than 10 listeners are +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Returns this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • By default EventEmitters will print a warning if more than 10 listeners are added for a particular event. This is a useful default that helps finding memory leaks. The emitter.setMaxListeners() method allows the limit to be modified for this specific EventEmitter instance. The value can be set to Infinity (or 0) to indicate an unlimited number of listeners.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns a reference to the EventEmitter, so that calls can be chained.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • n: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    v0.3.5

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • buffer: string | Uint8Array<ArrayBufferLike>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Optionalcb: (err?: Error) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • str: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Optionalencoding: BufferEncoding
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Optionalcb: (err?: Error) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • buffer: string | Uint8Array<ArrayBufferLike>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Optionalcb: (err?: Error) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • str: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Optionalencoding: BufferEncoding
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Optionalcb: (err?: Error) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/interfaces/_internal_.ReadableByteStreamController.html b/docs/interfaces/_internal_.ReadableByteStreamController.html index 99c9c31c..29cfdc51 100644 --- a/docs/interfaces/_internal_.ReadableByteStreamController.html +++ b/docs/interfaces/_internal_.ReadableByteStreamController.html @@ -1,6 +1,6 @@ -ReadableByteStreamController | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Interface ReadableByteStreamController

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    interface ReadableByteStreamController {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        byobRequest: undefined;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        desiredSize: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        close(): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        enqueue(chunk: ArrayBufferView): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        error(error?: any): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    byobRequest +ReadableByteStreamController | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Interface ReadableByteStreamController

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      interface ReadableByteStreamController {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          byobRequest: undefined;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          desiredSize: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          close(): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          enqueue(chunk: ArrayBufferView): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          error(error?: any): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      byobRequest desiredSize

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      close enqueue error -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      byobRequest: undefined
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      desiredSize: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Optionalerror: any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      byobRequest: undefined
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      desiredSize: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Optionalerror: any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/interfaces/_internal_.ReadableByteStreamControllerCallback.html b/docs/interfaces/_internal_.ReadableByteStreamControllerCallback.html index cd54670d..328c21f2 100644 --- a/docs/interfaces/_internal_.ReadableByteStreamControllerCallback.html +++ b/docs/interfaces/_internal_.ReadableByteStreamControllerCallback.html @@ -1 +1 @@ -ReadableByteStreamControllerCallback | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Interface ReadableByteStreamControllerCallback

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +ReadableByteStreamControllerCallback | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Interface ReadableByteStreamControllerCallback

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/interfaces/_internal_.ReadableStream-1.html b/docs/interfaces/_internal_.ReadableStream-1.html index 3425e04c..69a35908 100644 --- a/docs/interfaces/_internal_.ReadableStream-1.html +++ b/docs/interfaces/_internal_.ReadableStream-1.html @@ -1,5 +1,5 @@ ReadableStream | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Interface ReadableStream<R>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            This Streams API interface represents a readable stream of byte data.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            interface ReadableStream<R = any> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                locked: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                "[asyncIterator]"(): ReadableStreamAsyncIterator<R>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                cancel(reason?: any): Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                getReader(options: { mode: "byob" }): ReadableStreamBYOBReader;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                getReader(): ReadableStreamDefaultReader<R>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                getReader(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    options?: ReadableStreamGetReaderOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): ReadableStreamReader<R>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                pipeThrough<T>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    transform: ReadableWritablePair<T, R>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    options?: StreamPipeOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): ReadableStream<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                pipeTo(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    destination: WritableStream<R>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    options?: StreamPipeOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                tee(): [ReadableStream<R>, ReadableStream<R>];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                values(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    options?: { preventCancel?: boolean },
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): ReadableStreamAsyncIterator<R>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • R = any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            locked +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            interface ReadableStream<R = any> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                locked: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                "[asyncIterator]"(): ReadableStreamAsyncIterator<R>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                cancel(reason?: any): Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                getReader(options: { mode: "byob" }): ReadableStreamBYOBReader;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                getReader(): ReadableStreamDefaultReader<R>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                getReader(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    options?: ReadableStreamGetReaderOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): ReadableStreamReader<R>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                pipeThrough<T>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    transform: ReadableWritablePair<T, R>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    options?: StreamPipeOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): ReadableStream<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                pipeTo(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    destination: WritableStream<R>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    options?: StreamPipeOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                tee(): [ReadableStream<R>, ReadableStream<R>];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                values(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    options?: { preventCancel?: boolean },
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): ReadableStreamAsyncIterator<R>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • R = any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            locked

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            [asyncIterator] cancel getReader @@ -7,4 +7,4 @@ pipeTo tee values -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            locked: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Optionalreason: any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns Promise<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            locked: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Optionalreason: any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns Promise<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/interfaces/_internal_.ReadableStream.html b/docs/interfaces/_internal_.ReadableStream.html index 687b7977..0482c763 100644 --- a/docs/interfaces/_internal_.ReadableStream.html +++ b/docs/interfaces/_internal_.ReadableStream.html @@ -1,4 +1,4 @@ -ReadableStream | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              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.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                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 @@ -25,38 +25,38 @@ unpipe unshift wrap -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                readable: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • K

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • error: Error
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • event: string | symbol
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • ...args: AnyRest

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Alias for emitter.on(eventName, listener).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                readable: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • K

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • error: Error
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • event: string | symbol
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • ...args: AnyRest

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Alias for emitter.on(eventName, listener).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • K

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • eventName: string | symbol
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • listener: (...args: any[]) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  v0.1.26

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns true if the event had listeners, false otherwise.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  import { EventEmitter } from 'node:events';
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  const myEmitter = new EventEmitter();

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  // First listener
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  myEmitter.on('event', function firstListener() {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    console.log('Helloooo! first listener');
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  });
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  // Second listener
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  myEmitter.on('event', function secondListener(arg1, arg2) {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    console.log(`event with parameters ${arg1}, ${arg2} in second listener`);
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  });
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  // Third listener
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  myEmitter.on('event', function thirdListener(...args) {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    const parameters = args.join(', ');
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    console.log(`event with parameters ${parameters} in third listener`);
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  });

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  console.log(myEmitter.listeners('event'));

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  myEmitter.emit('event', 1, 2, 3, 4, 5);

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  // Prints:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  // [
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  //   [Function: firstListener],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  //   [Function: secondListener],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  //   [Function: thirdListener]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  // ]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  // Helloooo! first listener
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  // event with parameters 1, 2 in second listener
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  // event with parameters 1, 2, 3, 4, 5 in third listener

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • K

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • eventName: string | symbol
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • ...args: AnyRest

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  v0.1.26

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Returns an array listing the events for which the emitter has registered +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Returns an array listing the events for which the emitter has registered listeners. The values in the array are strings or Symbols.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  import { EventEmitter } from 'node:events';

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  const myEE = new EventEmitter();
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  myEE.on('foo', () => {});
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  myEE.on('bar', () => {});

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  const sym = Symbol('symbol');
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  myEE.on(sym, () => {});

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  console.log(myEE.eventNames());
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  // Prints: [ 'foo', 'bar', Symbol(symbol) ]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns (string | symbol)[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  v6.0.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Returns the current max listener value for the EventEmitter which is either +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Returns the current max listener value for the EventEmitter which is either set by emitter.setMaxListeners(n) or defaults to EventEmitter.defaultMaxListeners.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  v1.0.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Returns the number of listeners listening for the event named eventName. +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Returns the number of listeners listening for the event named eventName. If listener is provided, it will return how many times the listener is found in the list of the listeners of the event.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • K

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • eventName: string | symbol

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The name of the event being listened for

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Optionallistener: Function

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The event handler function

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  v3.2.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Returns a copy of the array of listeners for the event named eventName.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Optionallistener: Function

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The event handler function

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                v3.2.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Returns a copy of the array of listeners for the event named eventName.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  server.on('connection', (stream) => {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    console.log('someone connected!');
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  });
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  console.log(util.inspect(server.listeners('connection')));
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  // Prints: [ [Function] ]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • K

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • eventName: string | symbol

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns Function[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  v0.1.26

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Alias for emitter.removeListener().

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Alias for emitter.removeListener().

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • K

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • eventName: string | symbol
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • listener: (...args: any[]) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  v10.0.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Adds the listener function to the end of the listeners array for the event +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Adds the listener function to the end of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  @@ -70,9 +70,9 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • K

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • eventName: string | symbol

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The name of the event.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • listener: (...args: any[]) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The callback function

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  v0.1.101

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Adds a one-time listener function for the event named eventName. The +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • listener: (...args: any[]) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The callback function

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                v0.1.101

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Adds a one-time listener function for the event named eventName. The next time eventName is triggered, this listener is removed and then invoked.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  server.once('connection', (stream) => {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    console.log('Ah, we have our first user!');
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  });
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  @@ -84,9 +84,9 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • K

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • eventName: string | symbol

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The name of the event.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • listener: (...args: any[]) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The callback function

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  v0.3.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Returns this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • destination: T
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Optionaloptions: { end?: boolean }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Adds the listener function to the beginning of the listeners array for the +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • listener: (...args: any[]) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The callback function

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                v0.3.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Returns this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • destination: T
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Optionaloptions: { end?: boolean }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Adds the listener function to the beginning of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  @@ -95,30 +95,30 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns a reference to the EventEmitter, so that calls can be chained.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • K

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • eventName: string | symbol

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The name of the event.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • listener: (...args: any[]) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The callback function

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  v6.0.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Adds a one-timelistener function for the event named eventName to the beginning of the listeners array. The next time eventName is triggered, this +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • listener: (...args: any[]) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The callback function

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                v6.0.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Adds a one-timelistener function for the event named eventName to the beginning of the listeners array. The next time eventName is triggered, this listener is removed, and then invoked.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  server.prependOnceListener('connection', (stream) => {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    console.log('Ah, we have our first user!');
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  });

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns a reference to the EventEmitter, so that calls can be chained.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • K

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • eventName: string | symbol

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The name of the event.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • listener: (...args: any[]) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The callback function

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  v6.0.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Returns a copy of the array of listeners for the event named eventName, +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • listener: (...args: any[]) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The callback function

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                v6.0.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Returns a copy of the array of listeners for the event named eventName, including any wrappers (such as those created by .once()).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  import { EventEmitter } from 'node:events';
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  const emitter = new EventEmitter();
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  emitter.once('log', () => console.log('log once'));

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  // Returns a new Array with a function `onceWrapper` which has a property
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  // `listener` which contains the original listener bound above
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  const listeners = emitter.rawListeners('log');
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  const logFnWrapper = listeners[0];

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  // Logs "log once" to the console and does not unbind the `once` event
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  logFnWrapper.listener();

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  // Logs "log once" to the console and removes the listener
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  logFnWrapper();

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  emitter.on('log', () => console.log('log persistently'));
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  // Will return a new Array with a single function bound by `.on()` above
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  const newListeners = emitter.rawListeners('log');

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  // Logs "log persistently" twice
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  newListeners[0]();
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  emitter.emit('log');

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • K

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • eventName: string | symbol

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns Function[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  v9.4.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Optionalsize: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns string | Buffer<ArrayBufferLike>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Removes all listeners, or those of the specified eventName.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Optionalsize: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns string | Buffer<ArrayBufferLike>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Removes all listeners, or those of the specified eventName.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  It is bad practice to remove listeners added elsewhere in the code, particularly when the EventEmitter instance was created by some other component or module (e.g. sockets or file streams).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns a reference to the EventEmitter, so that calls can be chained.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • OptionaleventName: string | symbol

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  v0.1.26

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Removes the specified listener from the listener array for the event named eventName.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Removes the specified listener from the listener array for the event named eventName.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  const callback = (stream) => {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    console.log('someone connected!');
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  server.on('connection', callback);
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  // ...
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  server.removeListener('connection', callback);
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  @@ -145,10 +145,10 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns a reference to the EventEmitter, so that calls can be chained.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • K

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • eventName: string | symbol
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • listener: (...args: any[]) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  v0.1.26

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Returns this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • By default EventEmitters will print a warning if more than 10 listeners are +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Returns this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • By default EventEmitters will print a warning if more than 10 listeners are added for a particular event. This is a useful default that helps finding memory leaks. The emitter.setMaxListeners() method allows the limit to be modified for this specific EventEmitter instance. The value can be set to Infinity (or 0) to indicate an unlimited number of listeners.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns a reference to the EventEmitter, so that calls can be chained.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • n: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  v0.3.5

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/interfaces/_internal_.ReadableStreamAsyncIterator.html b/docs/interfaces/_internal_.ReadableStreamAsyncIterator.html index d431ed15..ebdb293f 100644 --- a/docs/interfaces/_internal_.ReadableStreamAsyncIterator.html +++ b/docs/interfaces/_internal_.ReadableStreamAsyncIterator.html @@ -1,6 +1,6 @@ -ReadableStreamAsyncIterator | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  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.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    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? throw? -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Returns PromiseLike<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • ...__namedParameters: [] | [unknown]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns Promise<IteratorResult<T, any>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Returns PromiseLike<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • ...__namedParameters: [] | [unknown]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns Promise<IteratorResult<T, any>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Optionalvalue: any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns Promise<IteratorResult<T, any>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Optionale: any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns Promise<IteratorResult<T, any>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/interfaces/_internal_.ReadableStreamBYOBReader.html b/docs/interfaces/_internal_.ReadableStreamBYOBReader.html index fadff951..c1a6f600 100644 --- a/docs/interfaces/_internal_.ReadableStreamBYOBReader.html +++ b/docs/interfaces/_internal_.ReadableStreamBYOBReader.html @@ -1,8 +1,8 @@ ReadableStreamBYOBReader | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      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 -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      closed: Promise<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Optionalreason: any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns Promise<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • MDN Reference

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      closed: Promise<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Optionalreason: any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns Promise<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • MDN Reference

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/interfaces/_internal_.ReadableStreamDefaultController.html b/docs/interfaces/_internal_.ReadableStreamDefaultController.html index cd755533..bb863216 100644 --- a/docs/interfaces/_internal_.ReadableStreamDefaultController.html +++ b/docs/interfaces/_internal_.ReadableStreamDefaultController.html @@ -1,5 +1,5 @@ -ReadableStreamDefaultController | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Interface ReadableStreamDefaultController<R>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        interface ReadableStreamDefaultController<R = any> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            desiredSize: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            close(): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            enqueue(chunk?: R): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            error(e?: any): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • R = any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        desiredSize +ReadableStreamDefaultController | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Interface ReadableStreamDefaultController<R>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          interface ReadableStreamDefaultController<R = any> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              desiredSize: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              close(): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              enqueue(chunk?: R): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              error(e?: any): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • R = any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          desiredSize

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          close enqueue error -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          desiredSize: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Optionalchunk: R

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Optionale: any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          desiredSize: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Optionalchunk: R

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Optionale: any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/interfaces/_internal_.ReadableStreamDefaultReader.html b/docs/interfaces/_internal_.ReadableStreamDefaultReader.html index 91e880bd..a382029a 100644 --- a/docs/interfaces/_internal_.ReadableStreamDefaultReader.html +++ b/docs/interfaces/_internal_.ReadableStreamDefaultReader.html @@ -1,5 +1,5 @@ -ReadableStreamDefaultReader | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            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.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              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 -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              closed: Promise<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Optionalreason: any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns Promise<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              closed: Promise<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Optionalreason: any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns Promise<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/interfaces/_internal_.ReadableStreamErrorCallback.html b/docs/interfaces/_internal_.ReadableStreamErrorCallback.html index e69f11f7..7b2a44bd 100644 --- a/docs/interfaces/_internal_.ReadableStreamErrorCallback.html +++ b/docs/interfaces/_internal_.ReadableStreamErrorCallback.html @@ -1 +1 @@ -ReadableStreamErrorCallback | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Interface ReadableStreamErrorCallback

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • reason: any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns void | PromiseLike<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +ReadableStreamErrorCallback | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Interface ReadableStreamErrorCallback

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • reason: any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns void | PromiseLike<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/interfaces/_internal_.ReadableStreamGenericReader.html b/docs/interfaces/_internal_.ReadableStreamGenericReader.html index 97b526aa..dd5cd247 100644 --- a/docs/interfaces/_internal_.ReadableStreamGenericReader.html +++ b/docs/interfaces/_internal_.ReadableStreamGenericReader.html @@ -1,3 +1,3 @@ -ReadableStreamGenericReader | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    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.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      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
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      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_.ReadableStreamGetReaderOptions.html b/docs/interfaces/_internal_.ReadableStreamGetReaderOptions.html index 29e30a92..78915eaa 100644 --- a/docs/interfaces/_internal_.ReadableStreamGetReaderOptions.html +++ b/docs/interfaces/_internal_.ReadableStreamGetReaderOptions.html @@ -1,4 +1,4 @@ -ReadableStreamGetReaderOptions | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Interface ReadableStreamGetReaderOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        interface ReadableStreamGetReaderOptions {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            mode?: "byob";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        mode? +ReadableStreamGetReaderOptions | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Interface ReadableStreamGetReaderOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          interface ReadableStreamGetReaderOptions {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              mode?: "byob";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          mode?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          mode?: "byob"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Creates a ReadableStreamBYOBReader and locks the stream to the new reader.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          This call behaves the same way as the no-argument variant, except that it only works on readable byte streams, i.e. streams which were constructed specifically with the ability to handle "bring your own buffer" reading. The returned BYOB reader provides the ability to directly read individual chunks from the stream via its read() method, into developer-supplied buffers, allowing more precise control over allocation.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/interfaces/_internal_.ReadableStreamReadDoneResult.html b/docs/interfaces/_internal_.ReadableStreamReadDoneResult.html index 90f8e8a1..178f3112 100644 --- a/docs/interfaces/_internal_.ReadableStreamReadDoneResult.html +++ b/docs/interfaces/_internal_.ReadableStreamReadDoneResult.html @@ -1,3 +1,3 @@ -ReadableStreamReadDoneResult | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Interface ReadableStreamReadDoneResult<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            interface ReadableStreamReadDoneResult<T> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                done: true;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                value?: T;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • T
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            done +ReadableStreamReadDoneResult | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Interface ReadableStreamReadDoneResult<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              interface ReadableStreamReadDoneResult<T> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  done: true;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  value?: T;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • T
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              done value? -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              done: true
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              value?: T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              done: true
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              value?: T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/interfaces/_internal_.ReadableStreamReadValueResult.html b/docs/interfaces/_internal_.ReadableStreamReadValueResult.html index dbc13844..45c8281b 100644 --- a/docs/interfaces/_internal_.ReadableStreamReadValueResult.html +++ b/docs/interfaces/_internal_.ReadableStreamReadValueResult.html @@ -1,3 +1,3 @@ -ReadableStreamReadValueResult | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Interface ReadableStreamReadValueResult<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                interface ReadableStreamReadValueResult<T> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    done: false;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    value: T;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • T
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                done +ReadableStreamReadValueResult | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Interface ReadableStreamReadValueResult<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  interface ReadableStreamReadValueResult<T> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      done: false;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      value: T;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • T
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  done value -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  done: false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  value: T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  done: false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  value: T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/interfaces/_internal_.ReadableWritablePair.html b/docs/interfaces/_internal_.ReadableWritablePair.html index f5b82927..7e0f2f2b 100644 --- a/docs/interfaces/_internal_.ReadableWritablePair.html +++ b/docs/interfaces/_internal_.ReadableWritablePair.html @@ -1,9 +1,9 @@ -ReadableWritablePair | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Interface ReadableWritablePair<R, W>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    interface ReadableWritablePair<R = any, W = any> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        readable: ReadableStream<R>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        writable: WritableStream<W>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • R = any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • W = any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    readable +ReadableWritablePair | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Interface ReadableWritablePair<R, W>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      interface ReadableWritablePair<R = any, W = any> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          readable: ReadableStream<R>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          writable: WritableStream<W>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • R = any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • W = any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      readable writable -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      readable: ReadableStream<R>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      writable: WritableStream<W>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Provides a convenient, chainable way of piping this readable stream +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      readable: ReadableStream<R>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      writable: WritableStream<W>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Provides a convenient, chainable way of piping this readable stream through a transform stream (or any other { writable, readable } pair). It simply pipes the stream into the writable side of the supplied pair, and returns the readable side for further use.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Piping a stream will lock it for the duration of the pipe, preventing any other consumer from acquiring a reader.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/interfaces/_internal_.RegionInputConfig.html b/docs/interfaces/_internal_.RegionInputConfig.html index 1af94706..773eaeb2 100644 --- a/docs/interfaces/_internal_.RegionInputConfig.html +++ b/docs/interfaces/_internal_.RegionInputConfig.html @@ -1,5 +1,5 @@ RegionInputConfig | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Interface RegionInputConfig

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        interface RegionInputConfig {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            region?: string | Provider<string>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            useFipsEndpoint?: boolean | Provider<boolean>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        region? useFipsEndpoint?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        region?: string | Provider<string>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The AWS region to which this client will send requests

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        useFipsEndpoint?: boolean | Provider<boolean>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Enables FIPS compatible endpoints.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        useFipsEndpoint?: boolean | Provider<boolean>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Enables FIPS compatible endpoints.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/interfaces/_internal_.RemoveOperation.html b/docs/interfaces/_internal_.RemoveOperation.html index 454f3605..d7bc491c 100644 --- a/docs/interfaces/_internal_.RemoveOperation.html +++ b/docs/interfaces/_internal_.RemoveOperation.html @@ -1,3 +1,3 @@ -RemoveOperation | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Interface RemoveOperation

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          op +RemoveOperation | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            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 d719bce8..628e341a 100644 --- a/docs/interfaces/_internal_.ReplaceOperation.html +++ b/docs/interfaces/_internal_.ReplaceOperation.html @@ -1,4 +1,4 @@ -ReplaceOperation | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              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.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                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 9262f7cf..288d7422 100644 --- a/docs/interfaces/_internal_.RequestBodyObject.html +++ b/docs/interfaces/_internal_.RequestBodyObject.html @@ -1,4 +1,4 @@ -RequestBodyObject | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  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.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    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_.RequestHandler.html b/docs/interfaces/_internal_.RequestHandler.html index 791d04f4..22a26a6b 100644 --- a/docs/interfaces/_internal_.RequestHandler.html +++ b/docs/interfaces/_internal_.RequestHandler.html @@ -4,4 +4,4 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    destroy?: () => void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    handle: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        request: RequestType,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        handlerOptions?: HandlerOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ) => Promise<RequestHandlerOutput<ResponseType>>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    metadata?: RequestHandlerMetadata

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    metadata contains information of a handler. For example 'h2' refers this handler is for handling HTTP/2 requests, whereas 'h1' refers handling HTTP1 requests

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/interfaces/_internal_.RequestOptions-1.html b/docs/interfaces/_internal_.RequestOptions-1.html new file mode 100644 index 00000000..ff7c5cd6 --- /dev/null +++ b/docs/interfaces/_internal_.RequestOptions-1.html @@ -0,0 +1,33 @@ +RequestOptions | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      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? +agent? +auth? +createConnection? +defaultPort? +family? +headers? +hints? +host? +hostname? +insecureHTTPParser? +joinDuplicateHeaders? +localAddress? +localPort? +lookup? +maxHeaderSize? +method? +path? +port? +protocol? +setDefaultHeaders? +setHost? +signal? +socketPath? +timeout? +uniqueHeaders? +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Optional_defaultAgent

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      _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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      One or more supported getaddrinfo flags. Multiple flags may be +passed by bitwise ORing their values.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      host?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      hostname?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      insecureHTTPParser?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      joinDuplicateHeaders?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      localAddress?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      localPort?: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      lookup?: LookupFunction
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      maxHeaderSize?: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      16384
+
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      method?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      path?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      port?: string | number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      protocol?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      setDefaultHeaders?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      setHost?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      signal?: AbortSignal
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      socketPath?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      timeout?: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      uniqueHeaders?: (string | string[])[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/interfaces/_internal_.RequestOptions.html b/docs/interfaces/_internal_.RequestOptions.html new file mode 100644 index 00000000..f170f215 --- /dev/null +++ b/docs/interfaces/_internal_.RequestOptions.html @@ -0,0 +1,160 @@ +RequestOptions | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        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? +agent? +allowPartialTrustChain? +ALPNCallback? +auth? +ca? +cert? +checkServerIdentity? +ciphers? +clientCertEngine? +createConnection? +crl? +defaultPort? +dhparam? +ecdhCurve? +family? +headers? +hints? +honorCipherOrder? +host? +hostname? +insecureHTTPParser? +joinDuplicateHeaders? +key? +localAddress? +localPort? +lookup? +maxHeaderSize? +maxVersion? +method? +minVersion? +passphrase? +path? +pfx? +port? +privateKeyEngine? +privateKeyIdentifier? +protocol? +rejectUnauthorized? +secureOptions? +secureProtocol? +servername? +sessionIdContext? +sessionTimeout? +setDefaultHeaders? +setHost? +sigalgs? +signal? +socketPath? +ticketKeys? +timeout? +uniqueHeaders? +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Optional_defaultAgent

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        _defaultAgent?: Agent
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        agent?: boolean | Agent
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        allowPartialTrustChain?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Treat intermediate (non-self-signed) +certificates in the trust CA certificate list as trusted.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        v22.9.0, v20.18.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ALPNCallback?: (arg: { protocols: string[]; servername: string }) => string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        If set, this will be called when a client opens a connection using the ALPN extension. +One argument will be passed to the callback: an object containing servername and protocols fields, +respectively containing the server name from the SNI extension (if any) and an array of +ALPN protocol name strings. The callback must return either one of the strings listed in protocols, +which will be returned to the client as the selected ALPN protocol, or undefined, +to reject the connection with a fatal alert. If a string is returned that does not match one of +the client's ALPN protocols, an error will be thrown. +This option cannot be used with the ALPNProtocols option, and setting both options will throw an error.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        auth?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ca?: string | Buffer<ArrayBufferLike> | (string | Buffer<ArrayBufferLike>)[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Optionally override the trusted CA certificates. Default is to trust +the well-known CAs curated by Mozilla. Mozilla's CAs are completely +replaced when CAs are explicitly specified using this option.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        cert?: string | Buffer<ArrayBufferLike> | (string | Buffer<ArrayBufferLike>)[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Cert chains in PEM format. One cert chain should be provided per +private key. Each cert chain should consist of the PEM formatted +certificate for a provided private key, followed by the PEM +formatted intermediate certificates (if any), in order, and not +including the root CA (the root CA must be pre-known to the peer, +see ca). When providing multiple cert chains, they do not have to +be in the same order as their private keys in key. If the +intermediate certificates are not provided, the peer will not be +able to validate the certificate, and the handshake will fail.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        checkServerIdentity?: (hostname: string, cert: DetailedPeerCertificate) => Error
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ciphers?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Cipher suite specification, replacing the default. For more +information, see modifying the default cipher suite. Permitted +ciphers can be obtained via tls.getCiphers(). Cipher names must be +uppercased in order for OpenSSL to accept them.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        clientCertEngine?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Name of an OpenSSL engine which can provide the client certificate.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        createConnection?: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            options: ClientRequestArgs,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            oncreate: (err: Error, socket: Duplex) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ) => Duplex
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        crl?: string | Buffer<ArrayBufferLike> | (string | Buffer<ArrayBufferLike>)[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        PEM formatted CRLs (Certificate Revocation Lists).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        defaultPort?: string | number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        dhparam?: string | Buffer<ArrayBufferLike>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        'auto' or custom Diffie-Hellman parameters, required for non-ECDHE perfect forward secrecy. +If omitted or invalid, the parameters are silently discarded and DHE ciphers will not be available. +ECDHE-based perfect forward secrecy will still be available.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ecdhCurve?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        A string describing a named curve or a colon separated list of curve +NIDs or names, for example P-521:P-384:P-256, to use for ECDH key +agreement. Set to auto to select the curve automatically. Use +crypto.getCurves() to obtain a list of available curve names. On +recent releases, openssl ecparam -list_curves will also display the +name and description of each available elliptic curve. Default: +tls.DEFAULT_ECDH_CURVE.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        family?: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        headers?: readonly string[] | OutgoingHttpHeaders
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        hints?: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        One or more supported getaddrinfo flags. Multiple flags may be +passed by bitwise ORing their values.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        honorCipherOrder?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Attempt to use the server's cipher suite preferences instead of the +client's. When true, causes SSL_OP_CIPHER_SERVER_PREFERENCE to be +set in secureOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        host?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        hostname?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        insecureHTTPParser?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        joinDuplicateHeaders?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        key?:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | Buffer<ArrayBufferLike>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | (string | Buffer<ArrayBufferLike> | KeyObject)[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Private keys in PEM format. PEM allows the option of private keys +being encrypted. Encrypted keys will be decrypted with +options.passphrase. Multiple keys using different algorithms can be +provided either as an array of unencrypted key strings or buffers, +or an array of objects in the form {pem: <string|buffer>[, +passphrase: ]}. The object form can only occur in an array. +object.passphrase is optional. Encrypted keys will be decrypted with +object.passphrase if provided, or options.passphrase if it is not.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        localAddress?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        localPort?: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        lookup?: LookupFunction
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        maxHeaderSize?: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        16384
+
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        maxVersion?: SecureVersion

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Optionally set the maximum TLS version to allow. One +of 'TLSv1.3', 'TLSv1.2', 'TLSv1.1', or 'TLSv1'. Cannot be specified along with the +secureProtocol option, use one or the other. +Default: 'TLSv1.3', unless changed using CLI options. Using +--tls-max-v1.2 sets the default to 'TLSv1.2'. Using --tls-max-v1.3 sets the default to +'TLSv1.3'. If multiple of the options are provided, the highest maximum is used.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        method?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        minVersion?: SecureVersion

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Optionally set the minimum TLS version to allow. One +of 'TLSv1.3', 'TLSv1.2', 'TLSv1.1', or 'TLSv1'. Cannot be specified along with the +secureProtocol option, use one or the other. It is not recommended to use +less than TLSv1.2, but it may be required for interoperability. +Default: 'TLSv1.2', unless changed using CLI options. Using +--tls-v1.0 sets the default to 'TLSv1'. Using --tls-v1.1 sets the default to +'TLSv1.1'. Using --tls-min-v1.3 sets the default to +'TLSv1.3'. If multiple of the options are provided, the lowest minimum is used.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        passphrase?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Shared passphrase used for a single private key and/or a PFX.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        path?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        pfx?:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | Buffer<ArrayBufferLike>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | (string | Buffer<ArrayBufferLike> | PxfObject)[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        PFX or PKCS12 encoded private key and certificate chain. pfx is an +alternative to providing key and cert individually. PFX is usually +encrypted, if it is, passphrase will be used to decrypt it. Multiple +PFX can be provided either as an array of unencrypted PFX buffers, +or an array of objects in the form {buf: <string|buffer>[, +passphrase: ]}. The object form can only occur in an array. +object.passphrase is optional. Encrypted PFX will be decrypted with +object.passphrase if provided, or options.passphrase if it is not.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        port?: string | number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        privateKeyEngine?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Name of an OpenSSL engine to get private key from. Should be used +together with privateKeyIdentifier.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        privateKeyIdentifier?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Identifier of a private key managed by an OpenSSL engine. Should be +used together with privateKeyEngine. Should not be set together with +key, because both options define a private key in different ways.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        protocol?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        rejectUnauthorized?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        secureOptions?: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Optionally affect the OpenSSL protocol behavior, which is not +usually necessary. This should be used carefully if at all! Value is +a numeric bitmask of the SSL_OP_* options from OpenSSL Options

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        secureProtocol?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Legacy mechanism to select the TLS protocol version to use, it does +not support independent control of the minimum and maximum version, +and does not support limiting the protocol to TLSv1.3. Use +minVersion and maxVersion instead. The possible values are listed as +SSL_METHODS, use the function names as strings. For example, use +'TLSv1_1_method' to force TLS version 1.1, or 'TLS_method' to allow +any TLS protocol version up to TLSv1.3. It is not recommended to use +TLS versions less than 1.2, but it may be required for +interoperability. Default: none, see minVersion.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        servername?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        sessionIdContext?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Opaque identifier used by servers to ensure session state is not +shared between applications. Unused by clients.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        sessionTimeout?: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The number of seconds after which a TLS session created by the +server will no longer be resumable. See Session Resumption for more +information. Default: 300.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        setDefaultHeaders?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        setHost?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        sigalgs?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Colon-separated list of supported signature algorithms. The list +can contain digest algorithms (SHA256, MD5 etc.), public key +algorithms (RSA-PSS, ECDSA etc.), combination of both (e.g +'RSA+SHA384') or TLS v1.3 scheme names (e.g. rsa_pss_pss_sha512).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        signal?: AbortSignal
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        socketPath?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ticketKeys?: Buffer<ArrayBufferLike>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        48-bytes of cryptographically strong pseudo-random data. +See Session Resumption for more information.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        timeout?: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        uniqueHeaders?: (string | string[])[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/interfaces/_internal_.RequestSigner.html b/docs/interfaces/_internal_.RequestSigner.html index d7831e2b..34ffaee6 100644 --- a/docs/interfaces/_internal_.RequestSigner.html +++ b/docs/interfaces/_internal_.RequestSigner.html @@ -1,5 +1,5 @@ RequestSigner | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Interface RequestSigner

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          An object that signs request objects with AWS credentials using one of the AWS authentication protocols.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          interface RequestSigner {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              sign(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  requestToSign: HttpRequest,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  options?: RequestSigningArguments,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ): Promise<HttpRequest>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          sign +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          interface RequestSigner {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              sign(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  requestToSign: HttpRequest,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  options?: RequestSigningArguments,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ): Promise<HttpRequest>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          sign

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns Promise<HttpRequest>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/interfaces/_internal_.RequestSigningArguments.html b/docs/interfaces/_internal_.RequestSigningArguments.html index e8206b83..190edc4a 100644 --- a/docs/interfaces/_internal_.RequestSigningArguments.html +++ b/docs/interfaces/_internal_.RequestSigningArguments.html @@ -1,4 +1,4 @@ -RequestSigningArguments | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            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.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              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? @@ -8,15 +8,15 @@ allowing them to be signed.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              All headers in the provided request will have their names converted to lower case before signing.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              signingDate?: DateInput

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The date and time to be used as signature metadata. This value should be +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              signingDate?: DateInput

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The date and time to be used as signature metadata. This value should be a Date object, a unix (epoch) timestamp, or a string that can be understood by the JavaScript Date constructor.If not supplied, the value returned by new Date() will be used.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              signingRegion?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The region name to sign the request. It will override the signing region of the +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              signingRegion?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The region name to sign the request. It will override the signing region of the signer in current invocation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              signingService?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The service signing name. It will override the service name of the signer +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              signingService?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The service signing name. It will override the service name of the signer in current invocation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              unsignableHeaders?: Set<string>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              A set of strings whose members represents headers that cannot be signed. +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              unsignableHeaders?: Set<string>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              A set of strings whose members represents headers that cannot be signed. All headers in the provided request will have their names converted to lower case and then checked for existence in the unsignableHeaders set.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/interfaces/_internal_.ResponseMetadata.html b/docs/interfaces/_internal_.ResponseMetadata.html index d827eef5..2d702e27 100644 --- a/docs/interfaces/_internal_.ResponseMetadata.html +++ b/docs/interfaces/_internal_.ResponseMetadata.html @@ -5,11 +5,11 @@ requestId? totalRetryDelay?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              attempts?: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The number of times this operation was attempted.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              cfId?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              A tertiary identifier for the last request sent. Used for debugging.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              extendedRequestId?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              A secondary identifier for the last request sent. Used for debugging.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              httpStatusCode?: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The status code of the last HTTP response received for this operation.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              requestId?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              A unique identifier for the last request sent for this operation. Often +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              cfId?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              A tertiary identifier for the last request sent. Used for debugging.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              extendedRequestId?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              A secondary identifier for the last request sent. Used for debugging.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              httpStatusCode?: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The status code of the last HTTP response received for this operation.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              requestId?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              A unique identifier for the last request sent for this operation. Often requested by AWS service teams to aid in debugging.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              totalRetryDelay?: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The total amount of time (in milliseconds) that was spent waiting between +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              totalRetryDelay?: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The total amount of time (in milliseconds) that was spent waiting between retry attempts.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/interfaces/_internal_.ResponseObject.html b/docs/interfaces/_internal_.ResponseObject.html index f8ff1048..8e5680fa 100644 --- a/docs/interfaces/_internal_.ResponseObject.html +++ b/docs/interfaces/_internal_.ResponseObject.html @@ -1,4 +1,4 @@ -ResponseObject | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                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.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  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 cdb88016..942aeed1 100644 --- a/docs/interfaces/_internal_.ResponsesObject.html +++ b/docs/interfaces/_internal_.ResponsesObject.html @@ -1,2 +1,2 @@ -ResponsesObject | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    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.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      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_.RetryErrorInfo.html b/docs/interfaces/_internal_.RetryErrorInfo.html index c5a96996..15640efc 100644 --- a/docs/interfaces/_internal_.RetryErrorInfo.html +++ b/docs/interfaces/_internal_.RetryErrorInfo.html @@ -2,8 +2,8 @@ errorType retryAfterHint?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      error?: SdkError

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The error thrown during the initial request, if available.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      errorType: RetryErrorType
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      retryAfterHint?: Date

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Protocol hint. This could come from Http's 'retry-after' header or +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      errorType: RetryErrorType
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      retryAfterHint?: Date

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Protocol hint. This could come from Http's 'retry-after' header or something from MQTT or any other protocol that has the ability to convey retry info from a peer.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The Date after which a retry should be attempted.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/interfaces/_internal_.RetryInputConfig.html b/docs/interfaces/_internal_.RetryInputConfig.html index e9c60f1c..64caaa51 100644 --- a/docs/interfaces/_internal_.RetryInputConfig.html +++ b/docs/interfaces/_internal_.RetryInputConfig.html @@ -1,5 +1,5 @@ RetryInputConfig | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Interface RetryInputConfig

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        interface RetryInputConfig {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            maxAttempts?: number | Provider<number>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            retryStrategy?: RetryStrategy | RetryStrategyV2;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        maxAttempts? retryStrategy?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        maxAttempts?: number | Provider<number>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The maximum number of times requests that encounter retryable failures should be attempted.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        retryStrategy?: RetryStrategy | RetryStrategyV2

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The strategy to retry the request. Using built-in exponential backoff strategy by default.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        retryStrategy?: RetryStrategy | RetryStrategyV2

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The strategy to retry the request. Using built-in exponential backoff strategy by default.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/interfaces/_internal_.RetryStrategy.html b/docs/interfaces/_internal_.RetryStrategy.html index aa62dc07..e8b1d6a9 100644 --- a/docs/interfaces/_internal_.RetryStrategy.html +++ b/docs/interfaces/_internal_.RetryStrategy.html @@ -1,8 +1,8 @@ RetryStrategy | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Interface RetryStrategy

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Interface that specifies the retry behavior

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          interface RetryStrategy {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              mode?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              retry: <Input extends object, Output extends MetadataBearer>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  next: FinalizeHandler<Input, Output>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  args: FinalizeHandlerArguments<Input>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ) => Promise<FinalizeHandlerOutput<Output>>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          mode? +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          interface RetryStrategy {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              mode?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              retry: <Input extends object, Output extends MetadataBearer>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  next: FinalizeHandler<Input, Output>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  args: FinalizeHandlerArguments<Input>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ) => Promise<FinalizeHandlerOutput<Output>>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          mode? retry

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          mode?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The retry mode describing how the retry strategy control the traffic flow.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          retry: <Input extends object, Output extends MetadataBearer>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              next: FinalizeHandler<Input, Output>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              args: FinalizeHandlerArguments<Input>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ) => Promise<FinalizeHandlerOutput<Output>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          the retry behavior the will invoke the next handler and handle the retry accordingly. +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          retry: <Input extends object, Output extends MetadataBearer>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              next: FinalizeHandler<Input, Output>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              args: FinalizeHandlerArguments<Input>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ) => Promise<FinalizeHandlerOutput<Output>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          the retry behavior the will invoke the next handler and handle the retry accordingly. This function should also update the $metadata from the response accordingly.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ResponseMetadata

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/interfaces/_internal_.RetryStrategyConfiguration.html b/docs/interfaces/_internal_.RetryStrategyConfiguration.html index 9adcf5db..ec45e2dc 100644 --- a/docs/interfaces/_internal_.RetryStrategyConfiguration.html +++ b/docs/interfaces/_internal_.RetryStrategyConfiguration.html @@ -1,6 +1,6 @@ RetryStrategyConfiguration | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns Provider<RetryStrategy | RetryStrategyV2>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/interfaces/_internal_.RetryStrategyV2.html b/docs/interfaces/_internal_.RetryStrategyV2.html index 377f848d..84cfb459 100644 --- a/docs/interfaces/_internal_.RetryStrategyV2.html +++ b/docs/interfaces/_internal_.RetryStrategyV2.html @@ -7,11 +7,11 @@ adding it here offers us a lot of future flexibility for outage detection. For example, it could be "us-east-1" on a shared retry strategy, or "us-west-2-c:dynamodb".

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • retryTokenScope: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns Promise<RetryToken>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Upon successful completion of the operation, this function is called +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • retryTokenScope: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns Promise<RetryToken>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Upon successful completion of the operation, this function is called to record that the operation was successful.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • After a failed operation call, this function is invoked to refresh the +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • After a failed operation call, this function is invoked to refresh the retryToken returned by acquireInitialRetryToken(). This function can either choose to allow another retry and send a new or updated token, or reject the retry attempt and report the error either in an exception or returning an error.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns Promise<RetryToken>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns Promise<RetryToken>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/interfaces/_internal_.RetryToken.html b/docs/interfaces/_internal_.RetryToken.html index 0425237d..84f587e2 100644 --- a/docs/interfaces/_internal_.RetryToken.html +++ b/docs/interfaces/_internal_.RetryToken.html @@ -1,5 +1,5 @@ RetryToken | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Interface RetryToken

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              interface RetryToken {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  getRetryCount(): number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  getRetryDelay(): number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              getRetryCount getRetryDelay

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Returns number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                the current count of retry.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Returns number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                the number of milliseconds to wait before retrying an action.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Returns number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                the number of milliseconds to wait before retrying an action.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/interfaces/_internal_.RetryableTrait.html b/docs/interfaces/_internal_.RetryableTrait.html index 6aaf15ef..31a2e9e6 100644 --- a/docs/interfaces/_internal_.RetryableTrait.html +++ b/docs/interfaces/_internal_.RetryableTrait.html @@ -1,5 +1,5 @@ RetryableTrait | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Interface RetryableTrait

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                A structure shape with the error trait. https://smithy.io/2.0/spec/behavior-traits.html#smithy-api-retryable-trait

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                interface RetryableTrait {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    throttling?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                throttling? +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                interface RetryableTrait {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    throttling?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                throttling?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                throttling?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Indicates that the error is a retryable throttling error.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/interfaces/_internal_.S3ClientConfig.html b/docs/interfaces/_internal_.S3ClientConfig.html index 910130a1..4567c34f 100644 --- a/docs/interfaces/_internal_.S3ClientConfig.html +++ b/docs/interfaces/_internal_.S3ClientConfig.html @@ -1,5 +1,5 @@ S3ClientConfig | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Interface S3ClientConfig

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The configuration interface of S3Client class constructor that set the region, credentials and other options.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  interface S3ClientConfig {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      apiVersion?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      authSchemePreference?: string[] | Provider<string[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      base64Decoder?: Decoder;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      base64Encoder?: Encoder;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      bodyLengthChecker?: BodyLengthCalculator;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      bucketEndpoint?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      cacheMiddleware?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      credentialDefaultProvider?: (input: any) => AwsCredentialIdentityProvider;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      credentials?: AwsCredentialIdentity | AwsCredentialIdentityProvider;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      customUserAgent?: string | UserAgent;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      defaultsMode?: DefaultsMode | Provider<DefaultsMode>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      defaultUserAgentProvider?: Provider<UserAgent>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      disableHostPrefix?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      disableMultiregionAccessPoints?: boolean & (boolean | Provider<boolean>);
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      disableS3ExpressSessionAuth?: boolean | Provider<boolean>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      endpoint?: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | EndpointV2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | Endpoint
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | Provider<Endpoint>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | Provider<EndpointV2>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ) & (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | EndpointV2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | Endpoint
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | Provider<Endpoint>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | Provider<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | Provider<EndpointV2>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      );
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      endpointProvider?: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          params: EndpointParameters,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          context?: { logger?: Logger },
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ) => EndpointV2;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      eventStreamSerdeProvider?: EventStreamSerdeProvider;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      extensions?: RuntimeExtension[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      followRegionRedirects?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      forcePathStyle?: boolean & (boolean | Provider<boolean>);
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      getAwsChunkedEncodingStream?: GetAwsChunkedEncodingStream;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      httpAuthSchemeProvider?: S3HttpAuthSchemeProvider;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      httpAuthSchemes?: HttpAuthScheme[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      logger?: Logger;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      maxAttempts?: number | Provider<number>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      md5?: HashConstructor | ChecksumConstructor;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      profile?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      region?: string | Provider<string>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      requestChecksumCalculation?:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | RequestChecksumCalculation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | Provider<RequestChecksumCalculation>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      requestHandler?: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | Record<string, unknown>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | NodeHttpHandlerOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | FetchHttpHandlerOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | RequestHandler<any, any, HttpHandlerOptions>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ) & HttpHandlerUserInput;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      requestStreamBufferSize?: number | false;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      responseChecksumValidation?:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | ResponseChecksumValidation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | Provider<ResponseChecksumValidation>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      retryMode?: string | Provider<string>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      retryStrategy?: RetryStrategy | RetryStrategyV2;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      runtime?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      s3ExpressIdentityProvider?: S3ExpressIdentityProvider;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      sdkStreamMixin?: SdkStreamMixinInjector;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      serviceConfiguredEndpoint?: never;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      serviceId?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      sha1?: HashConstructor | ChecksumConstructor;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      sha256?: HashConstructor | ChecksumConstructor;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      signer?:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | RequestSigner
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | ((authScheme?: AuthScheme) => Promise<RequestSigner>);
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      signerConstructor?: new (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          options: SignatureV4Init & SignatureV4CryptoInit,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ) => RequestSigner;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      signingEscapePath?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      signingRegion?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      sigv4aSigningRegionSet?: string[] | Provider<string[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      streamCollector?: StreamCollector;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      streamHasher?: StreamHasher<Readable> | StreamHasher<Blob>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      systemClockOffset?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      tls?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      urlParser?: UrlParser;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      useAccelerateEndpoint?: boolean & (boolean | Provider<boolean>);
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      useArnRegion?: boolean | Provider<boolean>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      useDualstackEndpoint?: boolean | Provider<boolean>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      useFipsEndpoint?: boolean | Provider<boolean>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      useGlobalEndpoint?: boolean | Provider<boolean>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      userAgentAppId?: string | Provider<string>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      utf8Decoder?: Decoder;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      utf8Encoder?: Encoder;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  apiVersion? +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  interface S3ClientConfig {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      apiVersion?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      authSchemePreference?: string[] | Provider<string[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      base64Decoder?: Decoder;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      base64Encoder?: Encoder;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      bodyLengthChecker?: BodyLengthCalculator;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      bucketEndpoint?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      cacheMiddleware?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      credentialDefaultProvider?: (input: any) => AwsCredentialIdentityProvider;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      credentials?: AwsCredentialIdentity | AwsCredentialIdentityProvider;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      customUserAgent?: string | UserAgent;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      defaultsMode?: DefaultsMode | Provider<DefaultsMode>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      defaultUserAgentProvider?: Provider<UserAgent>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      disableHostPrefix?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      disableMultiregionAccessPoints?: boolean & (boolean | Provider<boolean>);
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      disableS3ExpressSessionAuth?: boolean | Provider<boolean>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      endpoint?: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | EndpointV2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | Endpoint
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | Provider<Endpoint>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | Provider<EndpointV2>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ) & (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | EndpointV2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | Endpoint
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | Provider<Endpoint>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | Provider<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | Provider<EndpointV2>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      );
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      endpointProvider?: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          params: EndpointParameters,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          context?: { logger?: Logger },
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ) => EndpointV2;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      eventStreamSerdeProvider?: EventStreamSerdeProvider;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      expectContinueHeader?: number | boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      extensions?: RuntimeExtension[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      followRegionRedirects?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      forcePathStyle?: boolean & (boolean | Provider<boolean>);
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      getAwsChunkedEncodingStream?: GetAwsChunkedEncodingStream;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      httpAuthSchemeProvider?: S3HttpAuthSchemeProvider;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      httpAuthSchemes?: HttpAuthScheme[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      logger?: Logger;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      maxAttempts?: number | Provider<number>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      md5?: HashConstructor | ChecksumConstructor;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      profile?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      protocol?: ClientProtocol<HttpRequest, HttpResponse>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      region?: string | Provider<string>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      requestChecksumCalculation?:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | RequestChecksumCalculation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | Provider<RequestChecksumCalculation>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      requestHandler?: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | Record<string, unknown>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | NodeHttpHandlerOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | FetchHttpHandlerOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | RequestHandler<any, any, HttpHandlerOptions>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ) & HttpHandlerUserInput;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      requestStreamBufferSize?: number | false;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      responseChecksumValidation?:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | ResponseChecksumValidation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | Provider<ResponseChecksumValidation>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      retryMode?: string | Provider<string>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      retryStrategy?: RetryStrategy | RetryStrategyV2;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      runtime?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      s3ExpressIdentityProvider?: S3ExpressIdentityProvider;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      sdkStreamMixin?: SdkStreamMixinInjector;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      serviceConfiguredEndpoint?: never;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      serviceId?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      sha1?: HashConstructor | ChecksumConstructor;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      sha256?: HashConstructor | ChecksumConstructor;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      signer?:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | RequestSigner
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | ((authScheme?: AuthScheme) => Promise<RequestSigner>);
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      signerConstructor?: new (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          options: SignatureV4Init & SignatureV4CryptoInit,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ) => RequestSigner;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      signingEscapePath?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      signingRegion?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      sigv4aSigningRegionSet?: string[] | Provider<string[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      streamCollector?: StreamCollector;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      streamHasher?: StreamHasher<Readable> | StreamHasher<Blob>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      systemClockOffset?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      tls?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      urlParser?: UrlParser;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      useAccelerateEndpoint?: boolean & (boolean | Provider<boolean>);
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      useArnRegion?: boolean | Provider<boolean>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      useDualstackEndpoint?: boolean | Provider<boolean>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      useFipsEndpoint?: boolean | Provider<boolean>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      useGlobalEndpoint?: boolean | Provider<boolean>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      userAgentAppId?: string | Provider<string>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      utf8Decoder?: Decoder;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      utf8Encoder?: Encoder;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  apiVersion? authSchemePreference? base64Decoder? base64Encoder? @@ -17,6 +17,7 @@ endpoint? endpointProvider? eventStreamSerdeProvider? +expectContinueHeader? extensions? followRegionRedirects? forcePathStyle? @@ -27,6 +28,7 @@ maxAttempts? md5? profile? +protocol? region? requestChecksumCalculation? requestHandler? @@ -61,14 +63,14 @@ utf8Encoder?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  apiVersion?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The API version set internally by the SDK, and is not planned to be used by customer code.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  authSchemePreference?: string[] | Provider<string[]>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  A comma-separated list of case-sensitive auth scheme names. +

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  A comma-separated list of case-sensitive auth scheme names. An auth scheme name is a fully qualified auth scheme ID with the namespace prefix trimmed. For example, the auth scheme with ID aws.auth#sigv4 is named sigv4.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  base64Decoder?: Decoder

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The function that will be used to convert a base64-encoded string to a byte array.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  base64Encoder?: Encoder

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The function that will be used to convert binary data to a base64-encoded string.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  bodyLengthChecker?: BodyLengthCalculator

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  A function that can calculate the length of a request body.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  bucketEndpoint?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Whether to use the bucket name as the endpoint for this client.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  cacheMiddleware?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Default false.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  base64Decoder?: Decoder

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The function that will be used to convert a base64-encoded string to a byte array.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  base64Encoder?: Encoder

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The function that will be used to convert binary data to a base64-encoded string.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  bodyLengthChecker?: BodyLengthCalculator

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  A function that can calculate the length of a request body.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  bucketEndpoint?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Whether to use the bucket name as the endpoint for this client.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  cacheMiddleware?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Default false.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  When true, the client will only resolve the middleware stack once per Command class. This means modifying the middlewareStack of the command or client after requests have been made will not be @@ -76,37 +78,46 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Calling client.destroy() also clears this cache.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Enable this only if needing the additional time saved (0-1ms per request) and not needing middleware modifications between requests.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  credentialDefaultProvider?: (input: any) => AwsCredentialIdentityProvider

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Default credentials provider; Not available in browser runtime.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  credentials?: AwsCredentialIdentity | AwsCredentialIdentityProvider

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The credentials used to sign requests.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  customUserAgent?: string | UserAgent

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The custom user agent header that would be appended to default one

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  defaultsMode?: DefaultsMode | Provider<DefaultsMode>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  defaultUserAgentProvider?: Provider<UserAgent>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The provider populating default tracking information to be sent with user-agent, x-amz-user-agent header

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  disableHostPrefix?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Disable dynamically changing the endpoint of the client based on the hostPrefix +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  credentialDefaultProvider?: (input: any) => AwsCredentialIdentityProvider

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Default credentials provider; Not available in browser runtime.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  credentials?: AwsCredentialIdentity | AwsCredentialIdentityProvider

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The credentials used to sign requests.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  customUserAgent?: string | UserAgent

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The custom user agent header that would be appended to default one

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  defaultsMode?: DefaultsMode | Provider<DefaultsMode>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  defaultUserAgentProvider?: Provider<UserAgent>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The provider populating default tracking information to be sent with user-agent, x-amz-user-agent header

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  disableHostPrefix?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  disableMultiregionAccessPoints?: boolean & (boolean | Provider<boolean>)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Whether multi-region access points (MRAP) should be disabled.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  disableS3ExpressSessionAuth?: boolean | Provider<boolean>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  endpoint?: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | EndpointV2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | Endpoint
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | Provider<Endpoint>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | Provider<EndpointV2>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ) & (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | EndpointV2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | Endpoint
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | Provider<Endpoint>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | Provider<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | Provider<EndpointV2>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  )

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The fully qualified endpoint of the webservice. This is only for using +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  disableMultiregionAccessPoints?: boolean & (boolean | Provider<boolean>)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Whether multi-region access points (MRAP) should be disabled.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  disableS3ExpressSessionAuth?: boolean | Provider<boolean>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  endpoint?: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | EndpointV2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | Endpoint
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | Provider<Endpoint>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | Provider<EndpointV2>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ) & (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | EndpointV2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | Endpoint
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | Provider<Endpoint>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | Provider<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | Provider<EndpointV2>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  )

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The fully qualified endpoint of the webservice. This is only for using a custom endpoint (for example, when using a local version of S3).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Endpoint transformations such as S3 applying a bucket to the hostname are still applicable to this custom endpoint.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  endpointProvider?: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      params: EndpointParameters,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      context?: { logger?: Logger },
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ) => EndpointV2

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Providing a custom endpointProvider will override +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  endpointProvider?: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      params: EndpointParameters,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      context?: { logger?: Logger },
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ) => EndpointV2

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Providing a custom endpointProvider will override built-in transformations of the endpoint such as S3 adding the bucket name to the hostname, since they are part of the default endpointProvider.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  eventStreamSerdeProvider?: EventStreamSerdeProvider

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The function that provides necessary utilities for generating and parsing event stream

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  extensions?: RuntimeExtension[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Optional extensions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  followRegionRedirects?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  This feature was previously called the S3 Global Client. +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  eventStreamSerdeProvider?: EventStreamSerdeProvider

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The function that provides necessary utilities for generating and parsing event stream

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  expectContinueHeader?: number | boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  This field configures the SDK's behavior around setting the expect: 100-continue header.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Default: 2_097_152 (2 MB)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  When given as a boolean - always send or omit the header. +When given as a number - minimum byte threshold of the payload before setting the header. +Unmeasurable payload sizes (streams) will set the header too.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The expect: 100-continue header is used to allow the server a chance to validate the PUT request +headers before the client begins to send the object payload. This avoids wasteful data transmission for a +request that is rejected.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  However, there is a trade-off where the request will take longer to complete.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  extensions?: RuntimeExtension[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Optional extensions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  followRegionRedirects?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  This feature was previously called the S3 Global Client. This can result in additional latency as failed requests are retried with a corrected region when receiving a permanent redirect error with status 301. This feature should only be used as a last resort if you do not know the region of your bucket(s) ahead of time.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  forcePathStyle?: boolean & (boolean | Provider<boolean>)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Whether to force path style URLs for S3 objects +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  forcePathStyle?: boolean & (boolean | Provider<boolean>)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Whether to force path style URLs for S3 objects (e.g., https://s3.amazonaws.com// instead of https://.s3.amazonaws.com/

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  getAwsChunkedEncodingStream?: GetAwsChunkedEncodingStream

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  A function that returns Readable Stream which follows aws-chunked encoding stream.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  httpAuthSchemeProvider?: S3HttpAuthSchemeProvider

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Configuration of an HttpAuthSchemeProvider for a client which resolves which HttpAuthScheme to use.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  httpAuthSchemes?: HttpAuthScheme[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Configuration of HttpAuthSchemes for a client which provides default identity providers and signers per auth scheme.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  logger?: Logger

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Optional logger for logging debug/info/warn/error.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  maxAttempts?: number | Provider<number>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Value for how many times a request will be made at most in case of retry.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  md5?: HashConstructor | ChecksumConstructor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  A constructor for a class implementing the __Checksum interface +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  getAwsChunkedEncodingStream?: GetAwsChunkedEncodingStream

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  A function that returns Readable Stream which follows aws-chunked encoding stream.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  httpAuthSchemeProvider?: S3HttpAuthSchemeProvider

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Configuration of an HttpAuthSchemeProvider for a client which resolves which HttpAuthScheme to use.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  httpAuthSchemes?: HttpAuthScheme[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Configuration of HttpAuthSchemes for a client which provides default identity providers and signers per auth scheme.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  logger?: Logger

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Optional logger for logging debug/info/warn/error.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  maxAttempts?: number | Provider<number>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Value for how many times a request will be made at most in case of retry.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  md5?: HashConstructor | ChecksumConstructor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  A constructor for a class implementing the __Checksum interface that computes MD5 hashes.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  profile?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Setting a client profile is similar to setting a value for the +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  profile?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  When set, and only for environments where an AWS configuration @@ -118,10 +129,14 @@ configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  region?: string | Provider<string>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The AWS region to which this client will send requests

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  requestChecksumCalculation?:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | RequestChecksumCalculation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | Provider<RequestChecksumCalculation>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Determines when a checksum will be calculated for request payloads.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  requestHandler?: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | Record<string, unknown>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | NodeHttpHandlerOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | FetchHttpHandlerOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | RequestHandler<any, any, HttpHandlerOptions>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ) & HttpHandlerUserInput

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  requestStreamBufferSize?: number | false

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Default 0 (off).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  protocol?: ClientProtocol<HttpRequest, HttpResponse>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The protocol controlling the message type (e.g. HTTP) and format (e.g. JSON) +may be overridden. A default will always be set by the client. +Available options depend on the service's supported protocols and will not be validated by +the client.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  region?: string | Provider<string>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The AWS region to which this client will send requests

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  requestChecksumCalculation?:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | RequestChecksumCalculation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | Provider<RequestChecksumCalculation>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Determines when a checksum will be calculated for request payloads.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  requestHandler?: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | Record<string, unknown>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | NodeHttpHandlerOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | FetchHttpHandlerOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | RequestHandler<any, any, HttpHandlerOptions>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ) & HttpHandlerUserInput

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  requestStreamBufferSize?: number | false

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Default 0 (off).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  When set to a value greater than or equal to 8192, sets the minimum number of bytes to buffer into a chunk when processing input streams with chunked encoding (that is, when request checksums are enabled). @@ -131,26 +146,26 @@ your input stream. You do not need to set this value if your stream already flows chunks of 8kb or greater.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  responseChecksumValidation?:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | ResponseChecksumValidation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | Provider<ResponseChecksumValidation>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Determines when checksum validation will be performed on response payloads.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  retryMode?: string | Provider<string>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Specifies which retry algorithm to use.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  responseChecksumValidation?:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | ResponseChecksumValidation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | Provider<ResponseChecksumValidation>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Determines when checksum validation will be performed on response payloads.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  retryMode?: string | Provider<string>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Specifies which retry algorithm to use.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-smithy-util-retry/Enum/RETRY_MODES/

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  retryStrategy?: RetryStrategy | RetryStrategyV2

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The strategy to retry the request. Using built-in exponential backoff strategy by default.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  runtime?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The runtime environment.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  s3ExpressIdentityProvider?: S3ExpressIdentityProvider

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Identity provider for an S3 feature.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  sdkStreamMixin?: SdkStreamMixinInjector

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The internal function that inject utilities to runtime-specific stream to help users consume the data

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  serviceConfiguredEndpoint?: never

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  This field is used internally so you should not fill any value to this field.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  serviceId?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Unique service identifier.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  sha1?: HashConstructor | ChecksumConstructor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  A constructor for a class implementing the __Checksum interface +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  retryStrategy?: RetryStrategy | RetryStrategyV2

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The strategy to retry the request. Using built-in exponential backoff strategy by default.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  runtime?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The runtime environment.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  s3ExpressIdentityProvider?: S3ExpressIdentityProvider

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Identity provider for an S3 feature.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  sdkStreamMixin?: SdkStreamMixinInjector

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The internal function that inject utilities to runtime-specific stream to help users consume the data

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  serviceConfiguredEndpoint?: never

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  This field is used internally so you should not fill any value to this field.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  serviceId?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Unique service identifier.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  sha1?: HashConstructor | ChecksumConstructor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  A constructor for a class implementing the __Checksum interface that computes SHA1 hashes.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  sha256?: HashConstructor | ChecksumConstructor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  A constructor for a class implementing the @smithy/types#ChecksumConstructor interface +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  sha256?: HashConstructor | ChecksumConstructor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  A constructor for a class implementing the @smithy/types#ChecksumConstructor interface that computes the SHA-256 HMAC or checksum of a string or binary buffer.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  signer?: RequestSigner | ((authScheme?: AuthScheme) => Promise<RequestSigner>)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The signer to use when signing requests.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  signerConstructor?: new (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      options: SignatureV4Init & SignatureV4CryptoInit,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ) => RequestSigner

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The injectable SigV4-compatible signer class constructor. If not supplied, +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  signer?: RequestSigner | ((authScheme?: AuthScheme) => Promise<RequestSigner>)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The signer to use when signing requests.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  signerConstructor?: new (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      options: SignatureV4Init & SignatureV4CryptoInit,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ) => RequestSigner

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The injectable SigV4-compatible signer class constructor. If not supplied, regular SignatureV4 constructor will be used.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  signingEscapePath?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Whether to escape request path when signing the request.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  signingRegion?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The region where you want to sign your request against. This +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  signingEscapePath?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Whether to escape request path when signing the request.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  signingRegion?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The region where you want to sign your request against. This can be different to the region in the endpoint.

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  This option will override the AWS sigv4a +

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

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The lookup order is:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    @@ -160,17 +175,17 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  1. signingRegionSet given by endpoint resolution.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  2. the singular region of the SDK client.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  streamCollector?: StreamCollector

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  A function that converts a stream into an array of bytes.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  streamHasher?: StreamHasher<Readable> | StreamHasher<Blob>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  A function that, given a hash constructor and a stream, calculates the +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  streamCollector?: StreamCollector

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  A function that converts a stream into an array of bytes.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  streamHasher?: StreamHasher<Readable> | StreamHasher<Blob>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  A function that, given a hash constructor and a stream, calculates the hash of the streamed value.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  systemClockOffset?: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  An offset value in milliseconds to apply to all signing times.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  tls?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Whether TLS is enabled for requests.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  systemClockOffset?: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  An offset value in milliseconds to apply to all signing times.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  tls?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Whether TLS is enabled for requests.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  urlParser?: UrlParser

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The function that will be used to convert strings into HTTP endpoints.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  useAccelerateEndpoint?: boolean & (boolean | Provider<boolean>)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Whether to use the S3 Transfer Acceleration endpoint by default

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  useArnRegion?: boolean | Provider<boolean>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Whether to override the request region with the region inferred from requested resource's ARN. Defaults to undefined.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  useDualstackEndpoint?: boolean | Provider<boolean>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Enables IPv6/IPv4 dualstack endpoint.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  useFipsEndpoint?: boolean | Provider<boolean>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Enables FIPS compatible endpoints.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  useGlobalEndpoint?: boolean | Provider<boolean>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  userAgentAppId?: string | Provider<string>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The application ID used to identify the application.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  utf8Decoder?: Decoder

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The function that will be used to convert a UTF8-encoded string to a byte array.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  utf8Encoder?: Encoder

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The function that will be used to convert binary data to a UTF-8 encoded string.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  apiVersionauthSchemePreferencebase64Decoderbase64EncoderbodyLengthCheckerbucketEndpointcacheMiddlewarecredentialDefaultProvidercredentialscustomUserAgentdefaultsModedefaultUserAgentProviderdisableHostPrefixdisableMultiregionAccessPointsdisableS3ExpressSessionAuthendpointendpointProvidereventStreamSerdeProviderextensionsfollowRegionRedirectsforcePathStylegetAwsChunkedEncodingStreamhttpAuthSchemeProviderhttpAuthSchemesloggermaxAttemptsmd5profileregionrequestChecksumCalculationrequestHandlerrequestStreamBufferSizeresponseChecksumValidationretryModeretryStrategyruntimes3ExpressIdentityProvidersdkStreamMixinserviceConfiguredEndpointserviceIdsha1sha256signersignerConstructorsigningEscapePathsigningRegionsigv4aSigningRegionSetstreamCollectorstreamHashersystemClockOffsettlsurlParseruseAccelerateEndpointuseArnRegionuseDualstackEndpointuseFipsEndpointuseGlobalEndpointuserAgentAppIdutf8Decoderutf8Encoder
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  useAccelerateEndpoint?: boolean & (boolean | Provider<boolean>)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Whether to use the S3 Transfer Acceleration endpoint by default

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  useArnRegion?: boolean | Provider<boolean>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Whether to override the request region with the region inferred from requested resource's ARN. Defaults to undefined.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  useDualstackEndpoint?: boolean | Provider<boolean>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Enables IPv6/IPv4 dualstack endpoint.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  useFipsEndpoint?: boolean | Provider<boolean>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Enables FIPS compatible endpoints.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  useGlobalEndpoint?: boolean | Provider<boolean>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  userAgentAppId?: string | Provider<string>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The application ID used to identify the application.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  utf8Decoder?: Decoder

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The function that will be used to convert a UTF8-encoded string to a byte array.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  utf8Encoder?: Encoder

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The function that will be used to convert binary data to a UTF-8 encoded string.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  apiVersionauthSchemePreferencebase64Decoderbase64EncoderbodyLengthCheckerbucketEndpointcacheMiddlewarecredentialDefaultProvidercredentialscustomUserAgentdefaultsModedefaultUserAgentProviderdisableHostPrefixdisableMultiregionAccessPointsdisableS3ExpressSessionAuthendpointendpointProvidereventStreamSerdeProviderexpectContinueHeaderextensionsfollowRegionRedirectsforcePathStylegetAwsChunkedEncodingStreamhttpAuthSchemeProviderhttpAuthSchemesloggermaxAttemptsmd5profileprotocolregionrequestChecksumCalculationrequestHandlerrequestStreamBufferSizeresponseChecksumValidationretryModeretryStrategyruntimes3ExpressIdentityProvidersdkStreamMixinserviceConfiguredEndpointserviceIdsha1sha256signersignerConstructorsigningEscapePathsigningRegionsigv4aSigningRegionSetstreamCollectorstreamHashersystemClockOffsettlsurlParseruseAccelerateEndpointuseArnRegionuseDualstackEndpointuseFipsEndpointuseGlobalEndpointuserAgentAppIdutf8Decoderutf8Encoder
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/interfaces/_internal_.S3ExpressIdentity.html b/docs/interfaces/_internal_.S3ExpressIdentity.html index 35b168b0..937fda3d 100644 --- a/docs/interfaces/_internal_.S3ExpressIdentity.html +++ b/docs/interfaces/_internal_.S3ExpressIdentity.html @@ -1,14 +1,14 @@ -S3ExpressIdentity | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Interface S3ExpressIdentity

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    accessKeyId +S3ExpressIdentity | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Interface S3ExpressIdentity

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      accessKeyId accountId? credentialScope? expiration? secretAccessKey sessionToken?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      accessKeyId: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      AWS access key ID

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      accountId?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      AWS accountId.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      credentialScope?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      AWS credential scope for this set of credentials.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      expiration?: Date

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      secretAccessKey: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      AWS secret access key

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      sessionToken?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      A security or session token to use with these credentials. Usually +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      accountId?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      AWS accountId.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      credentialScope?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      AWS credential scope for this set of credentials.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      expiration?: Date

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      secretAccessKey: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      AWS secret access key

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      sessionToken?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      A security or session token to use with these credentials. Usually present for temporary credentials.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/interfaces/_internal_.S3ExpressIdentityProvider.html b/docs/interfaces/_internal_.S3ExpressIdentityProvider.html index d4595f69..1f847d2d 100644 --- a/docs/interfaces/_internal_.S3ExpressIdentityProvider.html +++ b/docs/interfaces/_internal_.S3ExpressIdentityProvider.html @@ -1,4 +1,4 @@ S3ExpressIdentityProvider | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Interface S3ExpressIdentityProvider

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        interface S3ExpressIdentityProvider {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            getS3ExpressIdentity(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                awsIdentity: AwsCredentialIdentity,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                identityProperties: Record<string, string>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ): Promise<S3ExpressIdentity>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        getS3ExpressIdentity

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • identityProperties: Record<string, string>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        unknown.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Returns Promise<S3ExpressIdentity>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/interfaces/_internal_.S3ExtensionConfiguration.html b/docs/interfaces/_internal_.S3ExtensionConfiguration.html index f56082ec..865b571b 100644 --- a/docs/interfaces/_internal_.S3ExtensionConfiguration.html +++ b/docs/interfaces/_internal_.S3ExtensionConfiguration.html @@ -1,4 +1,4 @@ -S3ExtensionConfiguration | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Interface S3ExtensionConfigurationInternal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          interface S3ExtensionConfiguration {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              addChecksumAlgorithm(algo: ChecksumAlgorithm): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              checksumAlgorithms(): ChecksumAlgorithm[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              credentials(): AwsCredentialIdentity | AwsCredentialIdentityProvider;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              httpAuthSchemeProvider(): S3HttpAuthSchemeProvider;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              httpAuthSchemes(): HttpAuthScheme[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              httpHandler(): HttpHandler<{}>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              httpHandlerConfigs(): {};
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              region(): Provider<string>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              retryStrategy(): Provider<RetryStrategy | RetryStrategyV2>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              setCredentials(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  credentials: AwsCredentialIdentity | AwsCredentialIdentityProvider,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              setHttpAuthScheme(httpAuthScheme: HttpAuthScheme): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              setHttpAuthSchemeProvider(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  httpAuthSchemeProvider: S3HttpAuthSchemeProvider,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              setHttpHandler(handler: HttpHandler<{}>): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              setRegion(region: Provider<string>): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              setRetryStrategy(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  retryStrategy: Provider<RetryStrategy | RetryStrategyV2>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              updateHttpClientConfig(key: never, value: never): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              [key: string]: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              [key: number]: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Indexable

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          addChecksumAlgorithm +S3ExtensionConfiguration | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Interface S3ExtensionConfigurationInternal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            interface S3ExtensionConfiguration {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                addChecksumAlgorithm(algo: ChecksumAlgorithm): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                checksumAlgorithms(): ChecksumAlgorithm[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                credentials(): AwsCredentialIdentity | AwsCredentialIdentityProvider;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                httpAuthSchemeProvider(): S3HttpAuthSchemeProvider;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                httpAuthSchemes(): HttpAuthScheme[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                httpHandler(): HttpHandler<{}>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                httpHandlerConfigs(): {};
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                region(): Provider<string>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                retryStrategy(): Provider<RetryStrategy | RetryStrategyV2>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                setCredentials(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    credentials: AwsCredentialIdentity | AwsCredentialIdentityProvider,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                setHttpAuthScheme(httpAuthScheme: HttpAuthScheme): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                setHttpAuthSchemeProvider(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    httpAuthSchemeProvider: S3HttpAuthSchemeProvider,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                setHttpHandler(handler: HttpHandler<{}>): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                setRegion(region: Provider<string>): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                setRetryStrategy(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    retryStrategy: Provider<RetryStrategy | RetryStrategyV2>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                updateHttpClientConfig(key: never, value: never): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                [key: string]: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                [key: number]: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Indexable

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            addChecksumAlgorithm checksumAlgorithms credentials httpAuthSchemeProvider @@ -14,6 +14,6 @@ setRegion setRetryStrategy updateHttpClientConfig -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Returns {}

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • key: never
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • value: never

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/interfaces/_internal_.S3HttpAuthSchemeParameters.html b/docs/interfaces/_internal_.S3HttpAuthSchemeParameters.html index ae0a6422..fd789c3e 100644 --- a/docs/interfaces/_internal_.S3HttpAuthSchemeParameters.html +++ b/docs/interfaces/_internal_.S3HttpAuthSchemeParameters.html @@ -1,4 +1,4 @@ -S3HttpAuthSchemeParameters | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Interface S3HttpAuthSchemeParametersInternal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              interface S3HttpAuthSchemeParameters {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Accelerate?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Bucket?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  CopySource?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  DisableAccessPoints?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  DisableMultiRegionAccessPoints?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  DisableS3ExpressSessionAuth?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Endpoint?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ForcePathStyle?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Key?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  operation?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Prefix?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  region?: 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? +S3HttpAuthSchemeParameters | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Interface S3HttpAuthSchemeParametersInternal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                interface S3HttpAuthSchemeParameters {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Accelerate?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Bucket?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    CopySource?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    DisableAccessPoints?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    DisableMultiRegionAccessPoints?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    DisableS3ExpressSessionAuth?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Endpoint?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ForcePathStyle?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Key?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    operation?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Prefix?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    region?: 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_.S3HttpAuthSchemeProvider.html b/docs/interfaces/_internal_.S3HttpAuthSchemeProvider.html index 9a3068c8..420eb2c5 100644 --- a/docs/interfaces/_internal_.S3HttpAuthSchemeProvider.html +++ b/docs/interfaces/_internal_.S3HttpAuthSchemeProvider.html @@ -1 +1 @@ -S3HttpAuthSchemeProvider | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Interface S3HttpAuthSchemeProviderInternal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +S3HttpAuthSchemeProvider | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Interface S3HttpAuthSchemeProviderInternal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/interfaces/_internal_.S3InputConfig.html b/docs/interfaces/_internal_.S3InputConfig.html index 35e4fe7c..30780ae3 100644 --- a/docs/interfaces/_internal_.S3InputConfig.html +++ b/docs/interfaces/_internal_.S3InputConfig.html @@ -1,18 +1,28 @@ S3InputConfig | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Interface S3InputConfig

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      All endpoint parameters with built-in bindings of AWS::S3::*

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      interface S3InputConfig {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          bucketEndpoint?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          disableMultiregionAccessPoints?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          followRegionRedirects?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          forcePathStyle?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          s3ExpressIdentityProvider?: S3ExpressIdentityProvider;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          useAccelerateEndpoint?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      bucketEndpoint? +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      interface S3InputConfig {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          bucketEndpoint?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          disableMultiregionAccessPoints?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          expectContinueHeader?: number | boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          followRegionRedirects?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          forcePathStyle?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          s3ExpressIdentityProvider?: S3ExpressIdentityProvider;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          useAccelerateEndpoint?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      bucketEndpoint? disableMultiregionAccessPoints? +expectContinueHeader? followRegionRedirects? forcePathStyle? s3ExpressIdentityProvider? useAccelerateEndpoint?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      bucketEndpoint?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Whether to use the bucket name as the endpoint for this client.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      disableMultiregionAccessPoints?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Whether multi-region access points (MRAP) should be disabled.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      followRegionRedirects?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      This feature was previously called the S3 Global Client. +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      disableMultiregionAccessPoints?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Whether multi-region access points (MRAP) should be disabled.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      expectContinueHeader?: number | boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      This field configures the SDK's behavior around setting the expect: 100-continue header.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Default: 2_097_152 (2 MB)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      When given as a boolean - always send or omit the header. +When given as a number - minimum byte threshold of the payload before setting the header. +Unmeasurable payload sizes (streams) will set the header too.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The expect: 100-continue header is used to allow the server a chance to validate the PUT request +headers before the client begins to send the object payload. This avoids wasteful data transmission for a +request that is rejected.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      However, there is a trade-off where the request will take longer to complete.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      followRegionRedirects?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      This feature was previously called the S3 Global Client. This can result in additional latency as failed requests are retried with a corrected region when receiving a permanent redirect error with status 301. This feature should only be used as a last resort if you do not know the region of your bucket(s) ahead of time.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      forcePathStyle?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Whether to force path style URLs for S3 objects +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      forcePathStyle?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Whether to force path style URLs for S3 objects (e.g., https://s3.amazonaws.com// instead of https://.s3.amazonaws.com/

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      s3ExpressIdentityProvider?: S3ExpressIdentityProvider

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Identity provider for an S3 feature.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      useAccelerateEndpoint?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Whether to use the S3 Transfer Acceleration endpoint by default

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      s3ExpressIdentityProvider?: S3ExpressIdentityProvider

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Identity provider for an S3 feature.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      useAccelerateEndpoint?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Whether to use the S3 Transfer Acceleration endpoint by default

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/interfaces/_internal_.ScalarTag.html b/docs/interfaces/_internal_.ScalarTag.html index acf4231f..ae573ab8 100644 --- a/docs/interfaces/_internal_.ScalarTag.html +++ b/docs/interfaces/_internal_.ScalarTag.html @@ -1,4 +1,4 @@ -ScalarTag | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Interface ScalarTag

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        interface ScalarTag {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            collection?: never;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            createNode?: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                schema: Schema,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                value: unknown,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ctx: CreateNodeContext,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ) => Node;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            default?: boolean | "key";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            format?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            identify?: (value: unknown) => boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            nodeClass?: never;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            stringify?: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                item: Scalar,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ctx: StringifyContext,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                onComment?: () => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                onChompKeep?: () => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ) => string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            tag: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            test?: RegExp;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            resolve(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                value: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                onError: (message: string) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                options: ParseOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ): unknown;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        collection? +ScalarTag | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Interface ScalarTag

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          interface ScalarTag {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              collection?: never;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              createNode?: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  schema: Schema,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  value: unknown,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ctx: CreateNodeContext,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ) => Node;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              default?: boolean | "key";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              format?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              identify?: (value: unknown) => boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              nodeClass?: never;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              stringify?: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  item: Scalar,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ctx: StringifyContext,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  onComment?: () => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  onChompKeep?: () => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ) => string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              tag: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              test?: RegExp;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              resolve(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  value: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  onError: (message: string) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  options: ParseOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ): unknown;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          collection? createNode? default? format? @@ -9,31 +9,31 @@ test?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          resolve

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          collection?: never
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          createNode?: (schema: Schema, value: unknown, ctx: CreateNodeContext) => Node

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          An optional factory function, used e.g. by collections when wrapping JS objects as AST nodes.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          default?: boolean | "key"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          If true, allows for values to be stringified without +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          default?: boolean | "key"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          If true, allows for values to be stringified without an explicit tag together with test. If 'key', this only applies if the value is used as a mapping key. For most cases, it's unlikely that you'll actually want to use this, even if you first think you do.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          format?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          If a tag has multiple forms that should be parsed and/or stringified +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          format?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          If a tag has multiple forms that should be parsed and/or stringified differently, use format to identify them.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          identify?: (value: unknown) => boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Used by YAML.createNode to detect your data type, e.g. using typeof or +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          identify?: (value: unknown) => boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Used by YAML.createNode to detect your data type, e.g. using typeof or instanceof.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          nodeClass?: never
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          stringify?: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              item: Scalar,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ctx: StringifyContext,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              onComment?: () => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              onChompKeep?: () => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ) => string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Optional function stringifying a Scalar node. If your data includes a +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          nodeClass?: never
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          stringify?: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              item: Scalar,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ctx: StringifyContext,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              onComment?: () => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              onChompKeep?: () => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ) => string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Optional function stringifying a Scalar node. If your data includes a suitable .toString() method, you can probably leave this undefined and use the default stringifier.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  item: Scalar,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ctx: StringifyContext,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  onComment?: () => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  onChompKeep?: () => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ): string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • item: Scalar

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                The node being stringified.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • ctx: StringifyContext

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Contains the stringifying context variables.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • OptionalonComment: () => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Callback to signal that the stringifier includes the +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        item: Scalar,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ctx: StringifyContext,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        onComment?: () => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        onChompKeep?: () => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • item: Scalar

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The node being stringified.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • ctx: StringifyContext

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Contains the stringifying context variables.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • OptionalonComment: () => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Callback to signal that the stringifier includes the item's comment in its output.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • OptionalonChompKeep: () => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Callback to signal that the output uses a block scalar +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • OptionalonChompKeep: () => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Callback to signal that the output uses a block scalar type with the + chomping indicator.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          tag: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The identifier for your data type, with which its stringified form will be +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          tag: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The identifier for your data type, with which its stringified form will be prefixed. Should either be a !-prefixed local !tag, or a fully qualified tag:domain,date:foo.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          test?: RegExp

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Together with default allows for values to be stringified without an +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          test?: RegExp

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Together with default allows for values to be stringified without an explicit tag and detected using a regular expression. For most cases, it's unlikely that you'll actually want to use these, even if you first think you do.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Turns a value into an AST node. +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Turns a value into an AST node. If returning a non-Node value, the output will be wrapped as a Scalar.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • value: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • onError: (message: string) => void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • options: ParseOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns unknown

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • value: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • onError: (message: string) => void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • options: ParseOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns unknown

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/interfaces/_internal_.SchemaObject.html b/docs/interfaces/_internal_.SchemaObject.html index 38cf6383..b8d7f7a0 100644 --- a/docs/interfaces/_internal_.SchemaObject.html +++ b/docs/interfaces/_internal_.SchemaObject.html @@ -1,4 +1,4 @@ -SchemaObject | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Interface SchemaObject

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            interface SchemaObject {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                $ref?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                additionalProperties?: boolean | SchemaObject | ReferenceObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                allOf?: (SchemaObject | ReferenceObject)[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                anyOf?: (SchemaObject | ReferenceObject)[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                const?: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                contentEncoding?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                contentMediaType?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                default?: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                deprecated?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                description?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                discriminator?: DiscriminatorObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                enum?: any[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                example?: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                examples?: any[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                exclusiveMaximum?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                exclusiveMinimum?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                externalDocs?: ExternalDocumentationObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                format?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                items?: SchemaObject | ReferenceObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                maximum?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                maxItems?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                maxLength?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                maxProperties?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                minimum?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                minItems?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                minLength?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                minProperties?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                multipleOf?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                not?: SchemaObject | ReferenceObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                oneOf?: (SchemaObject | ReferenceObject)[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                pattern?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                prefixItems?: (SchemaObject | ReferenceObject)[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                properties?: { [propertyName: string]: SchemaObject | ReferenceObject };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                propertyNames?: SchemaObject | ReferenceObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                readOnly?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                required?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                title?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                type?: SchemaObjectType | SchemaObjectType[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                uniqueItems?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                writeOnly?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                xml?: XmlObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                [extensionName: `x-${string}`]: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Indexable

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            $ref? +SchemaObject | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Interface SchemaObject

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              interface SchemaObject {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  $ref?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  additionalProperties?: boolean | SchemaObject | ReferenceObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  allOf?: (SchemaObject | ReferenceObject)[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  anyOf?: (SchemaObject | ReferenceObject)[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  const?: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  contentEncoding?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  contentMediaType?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  default?: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  deprecated?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  description?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  discriminator?: DiscriminatorObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  enum?: any[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  example?: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  examples?: any[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  exclusiveMaximum?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  exclusiveMinimum?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  externalDocs?: ExternalDocumentationObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  format?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  items?: SchemaObject | ReferenceObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  maximum?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  maxItems?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  maxLength?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  maxProperties?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  minimum?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  minItems?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  minLength?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  minProperties?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  multipleOf?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  not?: SchemaObject | ReferenceObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  oneOf?: (SchemaObject | ReferenceObject)[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  pattern?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  prefixItems?: (SchemaObject | ReferenceObject)[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  properties?: { [propertyName: string]: SchemaObject | ReferenceObject };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  propertyNames?: SchemaObject | ReferenceObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  readOnly?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  required?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  title?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  type?: SchemaObjectType | SchemaObjectType[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  uniqueItems?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  writeOnly?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  xml?: XmlObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  [extensionName: `x-${string}`]: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Indexable

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              $ref? additionalProperties? allOf? anyOf? diff --git a/docs/interfaces/_internal_.ScopesObject.html b/docs/interfaces/_internal_.ScopesObject.html index ddcf2005..7786a7ff 100644 --- a/docs/interfaces/_internal_.ScopesObject.html +++ b/docs/interfaces/_internal_.ScopesObject.html @@ -1 +1 @@ -ScopesObject | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Interface ScopesObject

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Indexable

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +ScopesObject | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Interface ScopesObject

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Indexable

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/interfaces/_internal_.SdkStreamMixin.html b/docs/interfaces/_internal_.SdkStreamMixin.html index 3c1b7f2c..8c09cbbe 100644 --- a/docs/interfaces/_internal_.SdkStreamMixin.html +++ b/docs/interfaces/_internal_.SdkStreamMixin.html @@ -1,7 +1,7 @@ SdkStreamMixin | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Interface SdkStreamMixin

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The interface contains mix-in utility functions to transfer the runtime-specific stream implementation to specified format. Each stream can ONLY be transformed once.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    interface SdkStreamMixin {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        transformToByteArray: () => Promise<Uint8Array<ArrayBufferLike>>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        transformToString: (encoding?: string) => Promise<string>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        transformToWebStream: () => ReadableStream;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    transformToByteArray +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    interface SdkStreamMixin {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        transformToByteArray: () => Promise<Uint8Array<ArrayBufferLike>>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        transformToString: (encoding?: string) => Promise<string>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        transformToWebStream: () => ReadableStream;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    transformToByteArray transformToString transformToWebStream

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    transformToByteArray: () => Promise<Uint8Array<ArrayBufferLike>>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    transformToString: (encoding?: string) => Promise<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    transformToWebStream: () => ReadableStream

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/interfaces/_internal_.SdkStreamMixinInjector.html b/docs/interfaces/_internal_.SdkStreamMixinInjector.html index f336f85c..96cb8b27 100644 --- a/docs/interfaces/_internal_.SdkStreamMixinInjector.html +++ b/docs/interfaces/_internal_.SdkStreamMixinInjector.html @@ -1,3 +1,3 @@ SdkStreamMixinInjector | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Interface SdkStreamMixinInjectorInternal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Interface for internal function to inject stream utility functions implementation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • stream: unknown

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns SdkStreamMixin

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • stream: unknown

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns SdkStreamMixin

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/interfaces/_internal_.SecureContext.html b/docs/interfaces/_internal_.SecureContext.html index a3af1027..3a6d58f2 100644 --- a/docs/interfaces/_internal_.SecureContext.html +++ b/docs/interfaces/_internal_.SecureContext.html @@ -1,2 +1,2 @@ -SecureContext | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Interface SecureContext

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        interface SecureContext {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            context: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        context -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        context: any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +SecureContext | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Interface SecureContext

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          interface SecureContext {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              context: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          context +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          context: any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/interfaces/_internal_.SecureContextOptions.html b/docs/interfaces/_internal_.SecureContextOptions.html index a71f9ab8..f9fd2e4e 100644 --- a/docs/interfaces/_internal_.SecureContextOptions.html +++ b/docs/interfaces/_internal_.SecureContextOptions.html @@ -1,4 +1,4 @@ -SecureContextOptions | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Interface SecureContextOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            interface SecureContextOptions {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                allowPartialTrustChain?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ALPNCallback?: (arg: { protocols: string[]; servername: string }) => string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ca?:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | Buffer<ArrayBufferLike>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | (string | Buffer<ArrayBufferLike>)[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                cert?:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | Buffer<ArrayBufferLike>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | (string | Buffer<ArrayBufferLike>)[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ciphers?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                clientCertEngine?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                crl?:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | Buffer<ArrayBufferLike>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | (string | Buffer<ArrayBufferLike>)[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                dhparam?: string | Buffer<ArrayBufferLike>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ecdhCurve?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                honorCipherOrder?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                key?:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | Buffer<ArrayBufferLike>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | (string | Buffer<ArrayBufferLike> | KeyObject)[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                maxVersion?: SecureVersion;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                minVersion?: SecureVersion;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                passphrase?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                pfx?:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | Buffer<ArrayBufferLike>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | (string | Buffer<ArrayBufferLike> | PxfObject)[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                privateKeyEngine?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                privateKeyIdentifier?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                secureOptions?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                secureProtocol?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                sessionIdContext?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                sessionTimeout?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                sigalgs?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ticketKeys?: Buffer<ArrayBufferLike>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            allowPartialTrustChain? +SecureContextOptions | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Interface SecureContextOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              interface SecureContextOptions {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  allowPartialTrustChain?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ALPNCallback?: (arg: { protocols: string[]; servername: string }) => string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ca?:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | Buffer<ArrayBufferLike>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | (string | Buffer<ArrayBufferLike>)[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  cert?:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | Buffer<ArrayBufferLike>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | (string | Buffer<ArrayBufferLike>)[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ciphers?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  clientCertEngine?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  crl?:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | Buffer<ArrayBufferLike>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | (string | Buffer<ArrayBufferLike>)[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  dhparam?: string | Buffer<ArrayBufferLike>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ecdhCurve?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  honorCipherOrder?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  key?:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | Buffer<ArrayBufferLike>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | (string | Buffer<ArrayBufferLike> | KeyObject)[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  maxVersion?: SecureVersion;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  minVersion?: SecureVersion;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  passphrase?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  pfx?:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | Buffer<ArrayBufferLike>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | (string | Buffer<ArrayBufferLike> | PxfObject)[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  privateKeyEngine?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  privateKeyIdentifier?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  secureOptions?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  secureProtocol?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  sessionIdContext?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  sessionTimeout?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  sigalgs?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ticketKeys?: Buffer<ArrayBufferLike>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              allowPartialTrustChain? ALPNCallback? ca? cert? @@ -24,7 +24,7 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              allowPartialTrustChain?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Treat intermediate (non-self-signed) certificates in the trust CA certificate list as trusted.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              v22.9.0, v20.18.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ALPNCallback?: (arg: { protocols: string[]; servername: string }) => string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              If set, this will be called when a client opens a connection using the ALPN extension. +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ALPNCallback?: (arg: { protocols: string[]; servername: string }) => string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              If set, this will be called when a client opens a connection using the ALPN extension. One argument will be passed to the callback: an object containing servername and protocols fields, respectively containing the server name from the SNI extension (if any) and an array of ALPN protocol name strings. The callback must return either one of the strings listed in protocols, @@ -32,10 +32,10 @@ to reject the connection with a fatal alert. If a string is returned that does not match one of the client's ALPN protocols, an error will be thrown. This option cannot be used with the ALPNProtocols option, and setting both options will throw an error.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ca?: string | Buffer<ArrayBufferLike> | (string | Buffer<ArrayBufferLike>)[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Optionally override the trusted CA certificates. Default is to trust +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ca?: string | Buffer<ArrayBufferLike> | (string | Buffer<ArrayBufferLike>)[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Optionally override the trusted CA certificates. Default is to trust the well-known CAs curated by Mozilla. Mozilla's CAs are completely replaced when CAs are explicitly specified using this option.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              cert?: string | Buffer<ArrayBufferLike> | (string | Buffer<ArrayBufferLike>)[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Cert chains in PEM format. One cert chain should be provided per +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              cert?: string | Buffer<ArrayBufferLike> | (string | Buffer<ArrayBufferLike>)[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Cert chains in PEM format. One cert chain should be provided per private key. Each cert chain should consist of the PEM formatted certificate for a provided private key, followed by the PEM formatted intermediate certificates (if any), in order, and not @@ -44,26 +44,26 @@ be in the same order as their private keys in key. If the intermediate certificates are not provided, the peer will not be able to validate the certificate, and the handshake will fail.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ciphers?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Cipher suite specification, replacing the default. For more +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ciphers?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Cipher suite specification, replacing the default. For more information, see modifying the default cipher suite. Permitted ciphers can be obtained via tls.getCiphers(). Cipher names must be uppercased in order for OpenSSL to accept them.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              clientCertEngine?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Name of an OpenSSL engine which can provide the client certificate.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              crl?: string | Buffer<ArrayBufferLike> | (string | Buffer<ArrayBufferLike>)[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              PEM formatted CRLs (Certificate Revocation Lists).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              dhparam?: string | Buffer<ArrayBufferLike>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              'auto' or custom Diffie-Hellman parameters, required for non-ECDHE perfect forward secrecy. +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              clientCertEngine?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Name of an OpenSSL engine which can provide the client certificate.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              crl?: string | Buffer<ArrayBufferLike> | (string | Buffer<ArrayBufferLike>)[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              PEM formatted CRLs (Certificate Revocation Lists).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              dhparam?: string | Buffer<ArrayBufferLike>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              'auto' or custom Diffie-Hellman parameters, required for non-ECDHE perfect forward secrecy. If omitted or invalid, the parameters are silently discarded and DHE ciphers will not be available. ECDHE-based perfect forward secrecy will still be available.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ecdhCurve?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              A string describing a named curve or a colon separated list of curve +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ecdhCurve?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              A string describing a named curve or a colon separated list of curve NIDs or names, for example P-521:P-384:P-256, to use for ECDH key agreement. Set to auto to select the curve automatically. Use crypto.getCurves() to obtain a list of available curve names. On recent releases, openssl ecparam -list_curves will also display the name and description of each available elliptic curve. Default: tls.DEFAULT_ECDH_CURVE.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              honorCipherOrder?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Attempt to use the server's cipher suite preferences instead of the +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              honorCipherOrder?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Attempt to use the server's cipher suite preferences instead of the client's. When true, causes SSL_OP_CIPHER_SERVER_PREFERENCE to be set in secureOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              key?:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | Buffer<ArrayBufferLike>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | (string | Buffer<ArrayBufferLike> | KeyObject)[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Private keys in PEM format. PEM allows the option of private keys +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              key?:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | Buffer<ArrayBufferLike>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | (string | Buffer<ArrayBufferLike> | KeyObject)[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Private keys in PEM format. PEM allows the option of private keys being encrypted. Encrypted keys will be decrypted with options.passphrase. Multiple keys using different algorithms can be provided either as an array of unencrypted key strings or buffers, @@ -71,13 +71,13 @@ passphrase: ]}. The object form can only occur in an array. object.passphrase is optional. Encrypted keys will be decrypted with object.passphrase if provided, or options.passphrase if it is not.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              maxVersion?: SecureVersion

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Optionally set the maximum TLS version to allow. One +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              maxVersion?: SecureVersion

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Optionally set the maximum TLS version to allow. One of 'TLSv1.3', 'TLSv1.2', 'TLSv1.1', or 'TLSv1'. Cannot be specified along with the secureProtocol option, use one or the other. Default: 'TLSv1.3', unless changed using CLI options. Using --tls-max-v1.2 sets the default to 'TLSv1.2'. Using --tls-max-v1.3 sets the default to 'TLSv1.3'. If multiple of the options are provided, the highest maximum is used.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              minVersion?: SecureVersion

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Optionally set the minimum TLS version to allow. One +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              minVersion?: SecureVersion

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Optionally set the minimum TLS version to allow. One of 'TLSv1.3', 'TLSv1.2', 'TLSv1.1', or 'TLSv1'. Cannot be specified along with the secureProtocol option, use one or the other. It is not recommended to use less than TLSv1.2, but it may be required for interoperability. @@ -85,8 +85,8 @@ --tls-v1.0 sets the default to 'TLSv1'. Using --tls-v1.1 sets the default to 'TLSv1.1'. Using --tls-min-v1.3 sets the default to 'TLSv1.3'. If multiple of the options are provided, the lowest minimum is used.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              passphrase?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Shared passphrase used for a single private key and/or a PFX.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              pfx?:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | Buffer<ArrayBufferLike>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | (string | Buffer<ArrayBufferLike> | PxfObject)[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              PFX or PKCS12 encoded private key and certificate chain. pfx is an +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              passphrase?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Shared passphrase used for a single private key and/or a PFX.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              pfx?:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | Buffer<ArrayBufferLike>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | (string | Buffer<ArrayBufferLike> | PxfObject)[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              PFX or PKCS12 encoded private key and certificate chain. pfx is an alternative to providing key and cert individually. PFX is usually encrypted, if it is, passphrase will be used to decrypt it. Multiple PFX can be provided either as an array of unencrypted PFX buffers, @@ -94,15 +94,15 @@ passphrase: ]}. The object form can only occur in an array. object.passphrase is optional. Encrypted PFX will be decrypted with object.passphrase if provided, or options.passphrase if it is not.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              privateKeyEngine?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Name of an OpenSSL engine to get private key from. Should be used +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              privateKeyEngine?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Name of an OpenSSL engine to get private key from. Should be used together with privateKeyIdentifier.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              privateKeyIdentifier?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Identifier of a private key managed by an OpenSSL engine. Should be +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              privateKeyIdentifier?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Identifier of a private key managed by an OpenSSL engine. Should be used together with privateKeyEngine. Should not be set together with key, because both options define a private key in different ways.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              secureOptions?: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Optionally affect the OpenSSL protocol behavior, which is not +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              secureOptions?: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Optionally affect the OpenSSL protocol behavior, which is not usually necessary. This should be used carefully if at all! Value is a numeric bitmask of the SSL_OP_* options from OpenSSL Options

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              secureProtocol?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Legacy mechanism to select the TLS protocol version to use, it does +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              secureProtocol?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Legacy mechanism to select the TLS protocol version to use, it does not support independent control of the minimum and maximum version, and does not support limiting the protocol to TLSv1.3. Use minVersion and maxVersion instead. The possible values are listed as @@ -111,15 +111,15 @@ any TLS protocol version up to TLSv1.3. It is not recommended to use TLS versions less than 1.2, but it may be required for interoperability. Default: none, see minVersion.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              sessionIdContext?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Opaque identifier used by servers to ensure session state is not +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              sessionIdContext?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Opaque identifier used by servers to ensure session state is not shared between applications. Unused by clients.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              sessionTimeout?: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The number of seconds after which a TLS session created by the +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              sessionTimeout?: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The number of seconds after which a TLS session created by the server will no longer be resumable. See Session Resumption for more information. Default: 300.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              sigalgs?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Colon-separated list of supported signature algorithms. The list +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              sigalgs?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Colon-separated list of supported signature algorithms. The list can contain digest algorithms (SHA256, MD5 etc.), public key algorithms (RSA-PSS, ECDSA etc.), combination of both (e.g 'RSA+SHA384') or TLS v1.3 scheme names (e.g. rsa_pss_pss_sha512).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ticketKeys?: Buffer<ArrayBufferLike>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              48-bytes of cryptographically strong pseudo-random data. +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ticketKeys?: Buffer<ArrayBufferLike>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              48-bytes of cryptographically strong pseudo-random data. See Session Resumption for more information.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/interfaces/_internal_.SecuritySchemeObject.html b/docs/interfaces/_internal_.SecuritySchemeObject.html index 9a40cd57..a02a1276 100644 --- a/docs/interfaces/_internal_.SecuritySchemeObject.html +++ b/docs/interfaces/_internal_.SecuritySchemeObject.html @@ -1,4 +1,4 @@ -SecuritySchemeObject | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Interface SecuritySchemeObject

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                interface SecuritySchemeObject {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    bearerFormat?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    description?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    flows?: OAuthFlowsObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    in?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    name?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    openIdConnectUrl?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    scheme?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    type: SecuritySchemeType;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    [extensionName: `x-${string}`]: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Indexable

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                bearerFormat? +SecuritySchemeObject | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Interface SecuritySchemeObject

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  interface SecuritySchemeObject {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      bearerFormat?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      description?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      flows?: OAuthFlowsObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      in?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      name?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      openIdConnectUrl?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      scheme?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      type: SecuritySchemeType;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      [extensionName: `x-${string}`]: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Indexable

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  bearerFormat? description? flows? in? diff --git a/docs/interfaces/_internal_.SerdeFunctions.html b/docs/interfaces/_internal_.SerdeFunctions.html new file mode 100644 index 00000000..1ba7c291 --- /dev/null +++ b/docs/interfaces/_internal_.SerdeFunctions.html @@ -0,0 +1,7 @@ +SerdeFunctions | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Interface SerdeFunctions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Serde functions from the client config.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    interface SerdeFunctions {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        base64Decoder: Decoder;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        base64Encoder: Encoder;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        streamCollector: StreamCollector;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        utf8Decoder: Decoder;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        utf8Encoder: Encoder;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    base64Decoder +base64Encoder +streamCollector +utf8Decoder +utf8Encoder +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    base64Decoder: Decoder
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    base64Encoder: Encoder
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    streamCollector: StreamCollector
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    utf8Decoder: Decoder
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    utf8Encoder: Encoder

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/interfaces/_internal_.SerializeHandlerArguments.html b/docs/interfaces/_internal_.SerializeHandlerArguments.html index 10f29a8f..38c53a54 100644 --- a/docs/interfaces/_internal_.SerializeHandlerArguments.html +++ b/docs/interfaces/_internal_.SerializeHandlerArguments.html @@ -1,10 +1,10 @@ -SerializeHandlerArguments | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Interface SerializeHandlerArguments<Input>

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Input extends object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      input +SerializeHandlerArguments | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Interface SerializeHandlerArguments<Input>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        interface SerializeHandlerArguments<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.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        request?: unknown

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The user input serialized as a request object. The request object is unknown, +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        request?: unknown

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The user input serialized as a request object. The request object is unknown, so you cannot modify it directly. When work with request, you need to guard its type to e.g. HttpRequest with 'instanceof' operand

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        During the build phase of the execution of a middleware stack, a built request may or may not be available.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/interfaces/_internal_.ServerObject.html b/docs/interfaces/_internal_.ServerObject.html index 14ec2aa1..b56ca8a3 100644 --- a/docs/interfaces/_internal_.ServerObject.html +++ b/docs/interfaces/_internal_.ServerObject.html @@ -1,4 +1,4 @@ -ServerObject | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Interface ServerObject

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          interface ServerObject {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              description?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              url: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              variables?: { [v: string]: ServerVariableObject };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              [extensionName: `x-${string}`]: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Indexable

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          description? +ServerObject | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Interface ServerObject

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            interface ServerObject {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                description?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                url: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                variables?: { [v: string]: ServerVariableObject };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                [extensionName: `x-${string}`]: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Indexable

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            description? url variables?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            description?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            url: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            variables?: { [v: string]: ServerVariableObject }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/interfaces/_internal_.ServerVariableObject.html b/docs/interfaces/_internal_.ServerVariableObject.html index 57c1113a..0ceda7fc 100644 --- a/docs/interfaces/_internal_.ServerVariableObject.html +++ b/docs/interfaces/_internal_.ServerVariableObject.html @@ -1,4 +1,4 @@ -ServerVariableObject | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Interface ServerVariableObject

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              interface ServerVariableObject {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  default: string | number | boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  description?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  enum?: string[] | number[] | boolean[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  [extensionName: `x-${string}`]: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Indexable

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              default +ServerVariableObject | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Interface ServerVariableObject

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                interface ServerVariableObject {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    default: string | number | boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    description?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    enum?: string[] | number[] | boolean[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    [extensionName: `x-${string}`]: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Indexable

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                default description? enum?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                default: string | number | boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                description?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                enum?: string[] | number[] | boolean[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                On This Page

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Interface ShapeDeserializer<SerializationType>Internal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Turns a serialization into a data object.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  use $ShapeDeserializer

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  interface ShapeDeserializer<SerializationType = Uint8Array> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      read(schema: Schema, data: SerializationType): any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      setSerdeContext(serdeContext: SerdeFunctions): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • SerializationType = Uint8Array

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  read +setSerdeContext +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/interfaces/_internal_.ShapeSerializer.html b/docs/interfaces/_internal_.ShapeSerializer.html new file mode 100644 index 00000000..7c598be8 --- /dev/null +++ b/docs/interfaces/_internal_.ShapeSerializer.html @@ -0,0 +1,6 @@ +ShapeSerializer | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Interface ShapeSerializer<SerializationType>Internal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Turns a data object into a serialization.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    use $ShapeSerializer

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    interface ShapeSerializer<SerializationType = Uint8Array> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        flush(): SerializationType;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        setSerdeContext(serdeContext: SerdeFunctions): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        write(schema: Schema, value: unknown): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • SerializationType = Uint8Array

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    flush +setSerdeContext +write +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/interfaces/_internal_.SignatureV4Init.html b/docs/interfaces/_internal_.SignatureV4Init.html index e2d2a7eb..9eea93c2 100644 --- a/docs/interfaces/_internal_.SignatureV4Init.html +++ b/docs/interfaces/_internal_.SignatureV4Init.html @@ -13,12 +13,12 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    credentials: AwsCredentialIdentity | Provider<AwsCredentialIdentity>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The credentials with which the request should be signed or a function that returns a promise that will be resolved with credentials.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    region: string | Provider<string>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The region name or a function that returns a promise that will be +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    region: string | Provider<string>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The region name or a function that returns a promise that will be resolved with the region name.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    service: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The service signing name.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    sha256?: HashConstructor | ChecksumConstructor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    A constructor function for a hash object that will calculate SHA-256 HMAC +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    service: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The service signing name.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    sha256?: HashConstructor | ChecksumConstructor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    A constructor function for a hash object that will calculate SHA-256 HMAC checksums.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    uriEscapePath?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Whether to uri-escape the request URI path as part of computing the +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    uriEscapePath?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Whether to uri-escape the request URI path as part of computing the canonical request string. This is required for every AWS service, except Amazon S3, as of late 2017.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    [true]
diff --git a/docs/interfaces/_internal_.SigningArguments.html b/docs/interfaces/_internal_.SigningArguments.html
index 9cd8d441..b08b2a3f 100644
--- a/docs/interfaces/_internal_.SigningArguments.html
+++ b/docs/interfaces/_internal_.SigningArguments.html
@@ -1,12 +1,12 @@
-SigningArguments | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Interface SigningArguments
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      interface SigningArguments {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          signingDate?: DateInput;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          signingRegion?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          signingService?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Hierarchy (View Summary)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Index
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      signingDate?
+SigningArguments | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Interface SigningArguments
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        interface SigningArguments {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            signingDate?: DateInput;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            signingRegion?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            signingService?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Hierarchy (View Summary)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Index
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        signingDate?
 signingRegion?
 signingService?
 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        signingDate?: DateInput
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The date and time to be used as signature metadata. This value should be
 a Date object, a unix (epoch) timestamp, or a string that can be
 understood by the JavaScript Date constructor.If not supplied, the
 value returned by new Date() will be used.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        
-
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        signingRegion?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The region name to sign the request. It will override the signing region of the
+
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        signingRegion?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The region name to sign the request. It will override the signing region of the
 signer in current invocation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        
-
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        signingService?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The service signing name. It will override the service name of the signer
+
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        signingService?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The service signing name. It will override the service name of the signer
 in current invocation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        
-
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        On This Page
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        
+

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/interfaces/_internal_.SmithyConfiguration.html b/docs/interfaces/_internal_.SmithyConfiguration.html index e364b516..a5f13c40 100644 --- a/docs/interfaces/_internal_.SmithyConfiguration.html +++ b/docs/interfaces/_internal_.SmithyConfiguration.html @@ -3,7 +3,7 @@ requestHandler

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        apiVersion: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The API version set internally by the SDK, and is not planned to be used by customer code.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        cacheMiddleware?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Default false.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        cacheMiddleware?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Default false.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        When true, the client will only resolve the middleware stack once per Command class. This means modifying the middlewareStack of the command or client after requests have been made will not be @@ -11,4 +11,4 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Calling client.destroy() also clears this cache.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Enable this only if needing the additional time saved (0-1ms per request) and not needing middleware modifications between requests.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        requestHandler:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | Record<string, unknown>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | NodeHttpHandlerOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | FetchHttpHandlerOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | RequestHandler<any, any, HandlerOptions>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        requestHandler:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | Record<string, unknown>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | NodeHttpHandlerOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | FetchHttpHandlerOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | RequestHandler<any, any, HandlerOptions>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/interfaces/_internal_.SmithyException.html b/docs/interfaces/_internal_.SmithyException.html index 8c5a3dbc..cb1a5d39 100644 --- a/docs/interfaces/_internal_.SmithyException.html +++ b/docs/interfaces/_internal_.SmithyException.html @@ -6,8 +6,8 @@ $service? name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        $fault: "client" | "server"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Whether the client or server are at fault.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        $response?: HttpResponse

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Reference to low-level HTTP response object.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        $retryable?: RetryableTrait

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Indicates that an error MAY be retried by the client.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        $service?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The service that encountered the exception.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        name: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The shape ID name of the exception.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        $response?: HttpResponse

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Reference to low-level HTTP response object.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        $retryable?: RetryableTrait

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Indicates that an error MAY be retried by the client.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        $service?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The service that encountered the exception.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        name: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The shape ID name of the exception.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/interfaces/_internal_.SocketAddressInitOptions.html b/docs/interfaces/_internal_.SocketAddressInitOptions.html index c8f2808f..3c5148b3 100644 --- a/docs/interfaces/_internal_.SocketAddressInitOptions.html +++ b/docs/interfaces/_internal_.SocketAddressInitOptions.html @@ -1,4 +1,4 @@ -SocketAddressInitOptions | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Interface SocketAddressInitOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          interface SocketAddressInitOptions {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              address?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              family?: IPVersion;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              flowlabel?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              port?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          address? +SocketAddressInitOptions | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Interface SocketAddressInitOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            interface SocketAddressInitOptions {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                address?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                family?: IPVersion;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                flowlabel?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                port?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            address? family? flowlabel? port? @@ -6,13 +6,13 @@ 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            127.0.0.1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            family?: IPVersion

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            'ipv4'

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            flowlabel?: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            An IPv6 flow-label used only if family is 'ipv6'.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            family?: IPVersion

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            'ipv4'

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            flowlabel?: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            An IPv6 flow-label used only if family is 'ipv6'.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            port?: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            An IP port.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            port?: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            An IP port.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/interfaces/_internal_.SocketConstructorOpts.html b/docs/interfaces/_internal_.SocketConstructorOpts.html index 7c97b0b5..94b20212 100644 --- a/docs/interfaces/_internal_.SocketConstructorOpts.html +++ b/docs/interfaces/_internal_.SocketConstructorOpts.html @@ -1,7 +1,7 @@ -SocketConstructorOpts | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Interface SocketConstructorOpts

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              interface SocketConstructorOpts {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  allowHalfOpen?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  fd?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  onread?: OnReadOpts;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  readable?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  signal?: AbortSignal;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  writable?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              allowHalfOpen? +SocketConstructorOpts | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Interface SocketConstructorOpts

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                interface SocketConstructorOpts {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    allowHalfOpen?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    fd?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    onread?: OnReadOpts;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    readable?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    signal?: AbortSignal;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    writable?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                allowHalfOpen? fd? onread? readable? signal? writable? -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                allowHalfOpen?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                fd?: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                onread?: OnReadOpts
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                readable?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                signal?: AbortSignal
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                writable?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                allowHalfOpen?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                fd?: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                onread?: OnReadOpts
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                readable?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                signal?: AbortSignal
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                writable?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/interfaces/_internal_.SpecIterable.html b/docs/interfaces/_internal_.SpecIterable.html index f46157eb..8e872cb2 100644 --- a/docs/interfaces/_internal_.SpecIterable.html +++ b/docs/interfaces/_internal_.SpecIterable.html @@ -1,2 +1,2 @@ -SpecIterable | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Interface SpecIterable<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  interface SpecIterable<T> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "[iterator]"(): SpecIterator<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Implemented by

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  [iterator] -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +SpecIterable | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Interface SpecIterable<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    interface SpecIterable<T> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "[iterator]"(): SpecIterator<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Implemented by

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    [iterator] +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/interfaces/_internal_.SpecIterableIterator.html b/docs/interfaces/_internal_.SpecIterableIterator.html index 17a17f2a..91b85299 100644 --- a/docs/interfaces/_internal_.SpecIterableIterator.html +++ b/docs/interfaces/_internal_.SpecIterableIterator.html @@ -1,3 +1,3 @@ -SpecIterableIterator | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Interface SpecIterableIterator<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      interface SpecIterableIterator<T> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "[iterator]"(): SpecIterableIterator<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          next(...args: [] | [undefined]): IteratorResult<T, any>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      [iterator] +SpecIterableIterator | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Interface SpecIterableIterator<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        interface SpecIterableIterator<T> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            "[iterator]"(): SpecIterableIterator<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            next(...args: [] | [undefined]): IteratorResult<T, any>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        [iterator] next -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/interfaces/_internal_.SpecIterator.html b/docs/interfaces/_internal_.SpecIterator.html index c7601a35..e02aee15 100644 --- a/docs/interfaces/_internal_.SpecIterator.html +++ b/docs/interfaces/_internal_.SpecIterator.html @@ -1,2 +1,2 @@ -SpecIterator | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Interface SpecIterator<T, TReturn, TNext>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          interface SpecIterator<T, TReturn = any, TNext = undefined> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              next(...args: [] | [TNext]): IteratorResult<T, TReturn>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • T
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • TReturn = any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • TNext = undefined

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          next -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +SpecIterator | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Interface SpecIterator<T, TReturn, TNext>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            interface SpecIterator<T, TReturn = any, TNext = undefined> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                next(...args: [] | [TNext]): IteratorResult<T, TReturn>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • T
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • TReturn = any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • TNext = undefined

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            next +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/interfaces/_internal_.StaticEventEmitterIteratorOptions.html b/docs/interfaces/_internal_.StaticEventEmitterIteratorOptions.html index 415b2296..396bfeaa 100644 --- a/docs/interfaces/_internal_.StaticEventEmitterIteratorOptions.html +++ b/docs/interfaces/_internal_.StaticEventEmitterIteratorOptions.html @@ -1,17 +1,17 @@ -StaticEventEmitterIteratorOptions | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Interface StaticEventEmitterIteratorOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              interface StaticEventEmitterIteratorOptions {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  close?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  highWaterMark?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  lowWaterMark?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  signal?: AbortSignal;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              close? +StaticEventEmitterIteratorOptions | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Interface StaticEventEmitterIteratorOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                interface StaticEventEmitterIteratorOptions {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    close?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    highWaterMark?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    lowWaterMark?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    signal?: AbortSignal;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                close? highWaterMark? lowWaterMark? signal?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                close?: string[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Names of events that will end the iteration.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                highWaterMark?: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                The high watermark. The emitter is paused every time the size of events being buffered is higher than it. +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                highWaterMark?: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                The high watermark. The emitter is paused every time the size of events being buffered is higher than it. Supported only on emitters implementing pause() and resume() methods.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Number.MAX_SAFE_INTEGER
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                lowWaterMark?: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                The low watermark. The emitter is resumed every time the size of events being buffered is lower than it. +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                lowWaterMark?: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                The low watermark. The emitter is resumed every time the size of events being buffered is lower than it. Supported only on emitters implementing pause() and resume() methods.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                signal?: AbortSignal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Can be used to cancel awaiting events.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                signal?: AbortSignal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Can be used to cancel awaiting events.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/interfaces/_internal_.StaticEventEmitterOptions.html b/docs/interfaces/_internal_.StaticEventEmitterOptions.html index 30dd0acc..abbe3b6e 100644 --- a/docs/interfaces/_internal_.StaticEventEmitterOptions.html +++ b/docs/interfaces/_internal_.StaticEventEmitterOptions.html @@ -1,3 +1,3 @@ -StaticEventEmitterOptions | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Interface StaticEventEmitterOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  interface StaticEventEmitterOptions {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      signal?: AbortSignal;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  signal? +StaticEventEmitterOptions | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Interface StaticEventEmitterOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    interface StaticEventEmitterOptions {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        signal?: AbortSignal;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    signal?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    signal?: AbortSignal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Can be used to cancel awaiting events.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/interfaces/_internal_.Stream.ArrayOptions.html b/docs/interfaces/_internal_.Stream.ArrayOptions.html index 9bf8a0d9..b5c0569b 100644 --- a/docs/interfaces/_internal_.Stream.ArrayOptions.html +++ b/docs/interfaces/_internal_.Stream.ArrayOptions.html @@ -5,4 +5,4 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    signal?: AbortSignal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Allows destroying the stream if the signal is aborted.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/interfaces/_internal_.Stream.DuplexOptions.html b/docs/interfaces/_internal_.Stream.DuplexOptions.html index 735c8f3c..28a1695a 100644 --- a/docs/interfaces/_internal_.Stream.DuplexOptions.html +++ b/docs/interfaces/_internal_.Stream.DuplexOptions.html @@ -1,22 +1,22 @@ -DuplexOptions | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Interface DuplexOptions<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      interface DuplexOptions<T extends Duplex = Duplex> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          allowHalfOpen?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          autoDestroy?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          decodeStrings?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          defaultEncoding?: BufferEncoding;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          emitClose?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          encoding?: BufferEncoding;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          highWaterMark?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          objectMode?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          readableHighWaterMark?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          readableObjectMode?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          signal?: AbortSignal;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          writableCorked?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          writableHighWaterMark?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          writableObjectMode?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          construct(this: T, callback: (error?: Error) => void): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          destroy(this: T, error: Error, callback: (error?: Error) => void): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          final(this: T, callback: (error?: Error) => void): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          read(this: T, size: number): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          write(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              this: T,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              chunk: any,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              encoding: BufferEncoding,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              callback: (error?: Error) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          writev(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              this: T,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              chunks: { chunk: any; encoding: BufferEncoding }[],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              callback: (error?: Error) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      allowHalfOpen? +DuplexOptions | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Interface DuplexOptions<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        interface DuplexOptions<T extends Duplex = Duplex> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            allowHalfOpen?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            autoDestroy?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            construct?: (this: T, callback: (error?: Error) => void) => void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            decodeStrings?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            defaultEncoding?: BufferEncoding;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            destroy?: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                this: T,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                error: Error,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                callback: (error?: Error) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ) => void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            emitClose?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            encoding?: BufferEncoding;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            final?: (this: T, callback: (error?: Error) => void) => void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            highWaterMark?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            objectMode?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            read?: (this: T, size: number) => void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            readableHighWaterMark?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            readableObjectMode?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            signal?: AbortSignal;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            writableCorked?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            writableHighWaterMark?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            writableObjectMode?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            write?: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                this: T,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                chunk: any,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                encoding: BufferEncoding,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                callback: (error?: Error) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ) => void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            writev?: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                this: T,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                chunks: { chunk: any; encoding: BufferEncoding }[],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                callback: (error?: Error) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ) => void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        allowHalfOpen? autoDestroy? +construct? decodeStrings? defaultEncoding? +destroy? emitClose? encoding? +final? highWaterMark? objectMode? +read? readableHighWaterMark? readableObjectMode? signal? writableCorked? writableHighWaterMark? writableObjectMode? -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        construct? -destroy? -final? -read? -write? -writev? -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        allowHalfOpen?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        autoDestroy?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        decodeStrings?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        defaultEncoding?: BufferEncoding
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        emitClose?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        encoding?: BufferEncoding
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        highWaterMark?: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        objectMode?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        readableHighWaterMark?: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        readableObjectMode?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        signal?: AbortSignal

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        writableCorked?: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        writableHighWaterMark?: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        writableObjectMode?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • this: T
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • callback: (error?: Error) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • this: T
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • error: Error
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • callback: (error?: Error) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • this: T
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • callback: (error?: Error) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • this: T
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • size: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • this: T
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • chunks: { chunk: any; encoding: BufferEncoding }[]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • callback: (error?: Error) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +write? +writev? +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        allowHalfOpen?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        autoDestroy?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        construct?: (this: T, callback: (error?: Error) => void) => void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        decodeStrings?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        defaultEncoding?: BufferEncoding
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        destroy?: (this: T, error: Error, callback: (error?: Error) => void) => void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        emitClose?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        encoding?: BufferEncoding
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        final?: (this: T, callback: (error?: Error) => void) => void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        highWaterMark?: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        objectMode?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        read?: (this: T, size: number) => void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        readableHighWaterMark?: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        readableObjectMode?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        signal?: AbortSignal

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        writableCorked?: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        writableHighWaterMark?: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        writableObjectMode?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        write?: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            this: T,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            chunk: any,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            encoding: BufferEncoding,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            callback: (error?: Error) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ) => void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        writev?: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            this: T,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            chunks: { chunk: any; encoding: BufferEncoding }[],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            callback: (error?: Error) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/interfaces/_internal_.Stream.FinishedOptions.html b/docs/interfaces/_internal_.Stream.FinishedOptions.html index 7aeab2c7..4528cbd9 100644 --- a/docs/interfaces/_internal_.Stream.FinishedOptions.html +++ b/docs/interfaces/_internal_.Stream.FinishedOptions.html @@ -1,6 +1,6 @@ -FinishedOptions | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Interface FinishedOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          interface FinishedOptions {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              error?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              readable?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              signal?: AbortSignal;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              writable?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          error? +FinishedOptions | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Interface FinishedOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            interface FinishedOptions {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                error?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                readable?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                signal?: AbortSignal;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                writable?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            error? readable? signal? writable? -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            error?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            readable?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            signal?: AbortSignal

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            writable?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            error?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            readable?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            signal?: AbortSignal

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            writable?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/interfaces/_internal_.Stream.Pipe.html b/docs/interfaces/_internal_.Stream.Pipe.html index c131ee12..7030e561 100644 --- a/docs/interfaces/_internal_.Stream.Pipe.html +++ b/docs/interfaces/_internal_.Stream.Pipe.html @@ -1,5 +1,5 @@ -Pipe | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Interface Pipe

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              interface Pipe {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  close(): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  hasRef(): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ref(): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  unref(): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              close +Pipe | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Interface Pipe

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                interface Pipe {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    close(): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    hasRef(): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ref(): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    unref(): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                close hasRef ref unref -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/interfaces/_internal_.Stream.PipelineOptions.html b/docs/interfaces/_internal_.Stream.PipelineOptions.html index 8db8b876..ba94ea33 100644 --- a/docs/interfaces/_internal_.Stream.PipelineOptions.html +++ b/docs/interfaces/_internal_.Stream.PipelineOptions.html @@ -1,3 +1,3 @@ -PipelineOptions | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Interface PipelineOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  interface PipelineOptions {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      end?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      signal?: AbortSignal;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  end? +PipelineOptions | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Interface PipelineOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    interface PipelineOptions {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        end?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        signal?: AbortSignal;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    end? signal? -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    end?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    signal?: AbortSignal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    end?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    signal?: AbortSignal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/interfaces/_internal_.Stream.ReadableOptions.html b/docs/interfaces/_internal_.Stream.ReadableOptions.html index dd263331..2e21a0b4 100644 --- a/docs/interfaces/_internal_.Stream.ReadableOptions.html +++ b/docs/interfaces/_internal_.Stream.ReadableOptions.html @@ -1,11 +1,11 @@ -ReadableOptions | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Interface ReadableOptions<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      interface ReadableOptions<T extends Readable = Readable> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          autoDestroy?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          emitClose?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          encoding?: BufferEncoding;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          highWaterMark?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          objectMode?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          signal?: AbortSignal;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          construct(this: T, callback: (error?: Error) => void): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          destroy(this: T, error: Error, callback: (error?: Error) => void): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          read(this: T, size: number): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      autoDestroy? +ReadableOptions | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Interface ReadableOptions<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        interface ReadableOptions<T extends Readable = Readable> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            autoDestroy?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            construct?: (this: T, callback: (error?: Error) => void) => void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            destroy?: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                this: T,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                error: Error,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                callback: (error?: Error) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ) => void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            emitClose?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            encoding?: BufferEncoding;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            highWaterMark?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            objectMode?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            read?: (this: T, size: number) => void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            signal?: AbortSignal;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        autoDestroy? +construct? +destroy? emitClose? encoding? highWaterMark? objectMode? +read? signal? -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        construct? -destroy? -read? -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        autoDestroy?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        emitClose?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        encoding?: BufferEncoding
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        highWaterMark?: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        objectMode?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        signal?: AbortSignal

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • this: T
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • callback: (error?: Error) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • this: T
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • error: Error
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • callback: (error?: Error) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • this: T
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • size: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        autoDestroy?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        construct?: (this: T, callback: (error?: Error) => void) => void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        destroy?: (this: T, error: Error, callback: (error?: Error) => void) => void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        emitClose?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        encoding?: BufferEncoding
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        highWaterMark?: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        objectMode?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        read?: (this: T, size: number) => void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        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_.Stream.StreamOptions.html b/docs/interfaces/_internal_.Stream.StreamOptions.html index ea4c6bd9..c0c88d95 100644 --- a/docs/interfaces/_internal_.Stream.StreamOptions.html +++ b/docs/interfaces/_internal_.Stream.StreamOptions.html @@ -1,9 +1,9 @@ -StreamOptions | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Interface StreamOptions<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          interface StreamOptions<T extends Stream> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              autoDestroy?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              emitClose?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              highWaterMark?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              objectMode?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              signal?: AbortSignal;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              construct(this: T, callback: (error?: Error) => void): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              destroy(this: T, error: Error, callback: (error?: Error) => void): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          autoDestroy? +StreamOptions | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Interface StreamOptions<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            interface StreamOptions<T extends Stream> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                autoDestroy?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                construct?: (this: T, callback: (error?: Error) => void) => void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                destroy?: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    this: T,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    error: Error,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    callback: (error?: Error) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ) => void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                emitClose?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                highWaterMark?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                objectMode?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                signal?: AbortSignal;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            autoDestroy? +construct? +destroy? emitClose? highWaterMark? objectMode? signal? -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            construct? -destroy? -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            autoDestroy?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            emitClose?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            highWaterMark?: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            objectMode?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            signal?: AbortSignal

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • this: T
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • callback: (error?: Error) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • this: T
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • error: Error
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • callback: (error?: Error) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            autoDestroy?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            construct?: (this: T, callback: (error?: Error) => void) => void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            destroy?: (this: T, error: Error, callback: (error?: Error) => void) => void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            emitClose?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            highWaterMark?: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            objectMode?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            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_.Stream.TransformOptions.html b/docs/interfaces/_internal_.Stream.TransformOptions.html index 588a2fb5..a96a7890 100644 --- a/docs/interfaces/_internal_.Stream.TransformOptions.html +++ b/docs/interfaces/_internal_.Stream.TransformOptions.html @@ -1,24 +1,24 @@ -TransformOptions | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Interface TransformOptions<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              interface TransformOptions<T extends Transform = Transform> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  allowHalfOpen?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  autoDestroy?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  decodeStrings?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  defaultEncoding?: BufferEncoding;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  emitClose?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  encoding?: BufferEncoding;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  highWaterMark?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  objectMode?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  readableHighWaterMark?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  readableObjectMode?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  signal?: AbortSignal;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  writableCorked?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  writableHighWaterMark?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  writableObjectMode?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  construct(this: T, callback: (error?: Error) => void): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  destroy(this: T, error: Error, callback: (error?: Error) => void): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  final(this: T, callback: (error?: Error) => void): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  flush(this: T, callback: TransformCallback): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  read(this: T, size: number): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  transform(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      this: T,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      chunk: any,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      encoding: BufferEncoding,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      callback: TransformCallback,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  write(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      this: T,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      chunk: any,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      encoding: BufferEncoding,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      callback: (error?: Error) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  writev(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      this: T,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      chunks: { chunk: any; encoding: BufferEncoding }[],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      callback: (error?: Error) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              allowHalfOpen? +TransformOptions | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Interface TransformOptions<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                interface TransformOptions<T extends Transform = Transform> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    allowHalfOpen?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    autoDestroy?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    construct?: (this: T, callback: (error?: Error) => void) => void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    decodeStrings?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    defaultEncoding?: BufferEncoding;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    destroy?: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        this: T,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        error: Error,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        callback: (error?: Error) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ) => void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    emitClose?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    encoding?: BufferEncoding;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    final?: (this: T, callback: (error?: Error) => void) => void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    flush?: (this: T, callback: TransformCallback) => void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    highWaterMark?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    objectMode?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    read?: (this: T, size: number) => void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    readableHighWaterMark?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    readableObjectMode?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    signal?: AbortSignal;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    transform?: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        this: T,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        chunk: any,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        encoding: BufferEncoding,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        callback: TransformCallback,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ) => void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    writableCorked?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    writableHighWaterMark?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    writableObjectMode?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    write?: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        this: T,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        chunk: any,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        encoding: BufferEncoding,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        callback: (error?: Error) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ) => void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    writev?: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        this: T,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        chunks: { chunk: any; encoding: BufferEncoding }[],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        callback: (error?: Error) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ) => void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                allowHalfOpen? autoDestroy? +construct? decodeStrings? defaultEncoding? +destroy? emitClose? encoding? +final? +flush? highWaterMark? objectMode? +read? readableHighWaterMark? readableObjectMode? signal? +transform? writableCorked? writableHighWaterMark? writableObjectMode? -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                construct? -destroy? -final? -flush? -read? -transform? -write? -writev? -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                allowHalfOpen?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                autoDestroy?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                decodeStrings?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                defaultEncoding?: BufferEncoding
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                emitClose?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                encoding?: BufferEncoding
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                highWaterMark?: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                objectMode?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                readableHighWaterMark?: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                readableObjectMode?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                signal?: AbortSignal

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                writableCorked?: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                writableHighWaterMark?: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                writableObjectMode?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • this: T
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • callback: (error?: Error) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • this: T
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • error: Error
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • callback: (error?: Error) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • this: T
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • callback: (error?: Error) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • this: T
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • size: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • this: T
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • chunks: { chunk: any; encoding: BufferEncoding }[]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • callback: (error?: Error) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +write? +writev? +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                allowHalfOpen?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                autoDestroy?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                construct?: (this: T, callback: (error?: Error) => void) => void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                decodeStrings?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                defaultEncoding?: BufferEncoding
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                destroy?: (this: T, error: Error, callback: (error?: Error) => void) => void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                emitClose?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                encoding?: BufferEncoding
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                final?: (this: T, callback: (error?: Error) => void) => void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                flush?: (this: T, callback: TransformCallback) => void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                highWaterMark?: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                objectMode?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                read?: (this: T, size: number) => void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                readableHighWaterMark?: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                readableObjectMode?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                signal?: AbortSignal

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                transform?: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    this: T,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    chunk: any,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    encoding: BufferEncoding,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    callback: TransformCallback,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ) => void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                writableCorked?: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                writableHighWaterMark?: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                writableObjectMode?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                write?: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    this: T,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    chunk: any,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    encoding: BufferEncoding,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    callback: (error?: Error) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ) => void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                writev?: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    this: T,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    chunks: { chunk: any; encoding: BufferEncoding }[],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    callback: (error?: Error) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/interfaces/_internal_.Stream.WritableOptions.html b/docs/interfaces/_internal_.Stream.WritableOptions.html index 97ac5b2a..3b414c91 100644 --- a/docs/interfaces/_internal_.Stream.WritableOptions.html +++ b/docs/interfaces/_internal_.Stream.WritableOptions.html @@ -1,14 +1,14 @@ -WritableOptions | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Interface WritableOptions<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  interface WritableOptions<T extends Writable = Writable> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      autoDestroy?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      decodeStrings?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      defaultEncoding?: BufferEncoding;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      emitClose?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      highWaterMark?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      objectMode?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      signal?: AbortSignal;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      construct(this: T, callback: (error?: Error) => void): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      destroy(this: T, error: Error, callback: (error?: Error) => void): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      final(this: T, callback: (error?: Error) => void): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      write(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          this: T,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          chunk: any,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          encoding: BufferEncoding,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          callback: (error?: Error) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      writev(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          this: T,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          chunks: { chunk: any; encoding: BufferEncoding }[],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          callback: (error?: Error) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  autoDestroy? +WritableOptions | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Interface WritableOptions<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    interface WritableOptions<T extends Writable = Writable> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        autoDestroy?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        construct?: (this: T, callback: (error?: Error) => void) => void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        decodeStrings?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        defaultEncoding?: BufferEncoding;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        destroy?: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            this: T,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            error: Error,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            callback: (error?: Error) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ) => void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        emitClose?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        final?: (this: T, callback: (error?: Error) => void) => void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        highWaterMark?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        objectMode?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        signal?: AbortSignal;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        write?: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            this: T,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            chunk: any,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            encoding: BufferEncoding,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            callback: (error?: Error) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ) => void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        writev?: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            this: T,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            chunks: { chunk: any; encoding: BufferEncoding }[],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            callback: (error?: Error) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ) => void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    autoDestroy? +construct? decodeStrings? defaultEncoding? +destroy? emitClose? +final? highWaterMark? objectMode? signal? -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    construct? -destroy? -final? -write? -writev? -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    autoDestroy?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    decodeStrings?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    defaultEncoding?: BufferEncoding
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    emitClose?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    highWaterMark?: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    objectMode?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    signal?: AbortSignal

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • this: T
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • callback: (error?: Error) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • this: T
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • error: Error
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • callback: (error?: Error) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • this: T
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • callback: (error?: Error) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • this: T
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • chunks: { chunk: any; encoding: BufferEncoding }[]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • callback: (error?: Error) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +write? +writev? +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    autoDestroy?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    construct?: (this: T, callback: (error?: Error) => void) => void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    decodeStrings?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    defaultEncoding?: BufferEncoding
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    destroy?: (this: T, error: Error, callback: (error?: Error) => void) => void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    emitClose?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    final?: (this: T, callback: (error?: Error) => void) => void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    highWaterMark?: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    objectMode?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    signal?: AbortSignal

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    write?: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        this: T,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        chunk: any,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        encoding: BufferEncoding,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        callback: (error?: Error) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ) => void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    writev?: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        this: T,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        chunks: { chunk: any; encoding: BufferEncoding }[],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        callback: (error?: Error) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/interfaces/_internal_.Stream.node_stream_promises.FinishedOptions.html b/docs/interfaces/_internal_.Stream.node_stream_promises.FinishedOptions.html index 83b326bd..ac275eaa 100644 --- a/docs/interfaces/_internal_.Stream.node_stream_promises.FinishedOptions.html +++ b/docs/interfaces/_internal_.Stream.node_stream_promises.FinishedOptions.html @@ -1,4 +1,4 @@ -FinishedOptions | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Interface FinishedOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      interface FinishedOptions {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          cleanup?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          error?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          readable?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          signal?: AbortSignal;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          writable?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      cleanup? +FinishedOptions | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Interface FinishedOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        interface FinishedOptions {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            cleanup?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            error?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            readable?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            signal?: AbortSignal;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            writable?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        cleanup? error? readable? signal? @@ -7,5 +7,5 @@ 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        error?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        readable?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        signal?: AbortSignal

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        writable?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        error?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        readable?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        signal?: AbortSignal

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        writable?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/interfaces/_internal_.StreamCollector.html b/docs/interfaces/_internal_.StreamCollector.html index 098d2728..1a75e705 100644 --- a/docs/interfaces/_internal_.StreamCollector.html +++ b/docs/interfaces/_internal_.StreamCollector.html @@ -1,3 +1,3 @@ StreamCollector | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Interface StreamCollector

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • A function that converts a stream into an array of bytes.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • stream: any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The low-level native stream from browser or Nodejs runtime

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns Promise<Uint8Array<ArrayBufferLike>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns Promise<Uint8Array<ArrayBufferLike>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/interfaces/_internal_.StreamHasher.html b/docs/interfaces/_internal_.StreamHasher.html index d1218185..6038eea8 100644 --- a/docs/interfaces/_internal_.StreamHasher.html +++ b/docs/interfaces/_internal_.StreamHasher.html @@ -1,4 +1,4 @@ StreamHasher | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Interface StreamHasher<StreamType>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            A function that calculates the hash of a data stream. Determining the hash will consume the stream, so only replayable streams should be provided to an implementation of this interface.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • StreamType = any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • StreamType = any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/interfaces/_internal_.StreamPipeOptions.html b/docs/interfaces/_internal_.StreamPipeOptions.html index 55dc1856..007505e2 100644 --- a/docs/interfaces/_internal_.StreamPipeOptions.html +++ b/docs/interfaces/_internal_.StreamPipeOptions.html @@ -1,8 +1,8 @@ -StreamPipeOptions | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Interface StreamPipeOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              interface StreamPipeOptions {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  preventAbort?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  preventCancel?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  preventClose?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  signal?: AbortSignal;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              preventAbort? +StreamPipeOptions | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Interface StreamPipeOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                interface StreamPipeOptions {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    preventAbort?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    preventCancel?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    preventClose?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    signal?: AbortSignal;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                preventAbort? preventCancel? preventClose? signal? -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                preventAbort?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                preventCancel?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                preventClose?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Pipes this readable stream to a given writable stream destination. +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                preventAbort?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                preventCancel?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                preventClose?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Pipes this readable stream to a given writable stream destination. The way in which the piping process behaves under various error conditions can be customized with a number of passed options. It returns a promise that fulfills when the piping process completes @@ -34,4 +34,4 @@ case, this source readable stream will be canceled, and destination aborted, unless the respective options preventCancel or preventAbort are set.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                signal?: AbortSignal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                signal?: AbortSignal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                On This Page

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Interface StructureSchemaInternal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Schema for the structure aggregate type.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  use static schema.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  interface StructureSchema {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      memberList: SchemaRef[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      memberNames: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      members?: Record<string, [SchemaRef, SchemaTraits]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      name: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      namespace: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      traits: SchemaTraits;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  memberList +memberNames +members? +name +namespace +traits +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  memberList: SchemaRef[]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  memberNames: string[]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  members?: Record<string, [SchemaRef, SchemaTraits]>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  structure member iteration will be linear on the memberNames and memberList arrays. +It can be collected into a hashmap form on an ad-hoc basis, but will not initialize as such.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  name: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  namespace: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  traits: SchemaTraits

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/interfaces/_internal_.TagBase.html b/docs/interfaces/_internal_.TagBase.html index 712b2539..2b318734 100644 --- a/docs/interfaces/_internal_.TagBase.html +++ b/docs/interfaces/_internal_.TagBase.html @@ -1,19 +1,19 @@ -TagBase | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Interface TagBase

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    interface TagBase {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        createNode?: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            schema: Schema,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            value: unknown,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ctx: CreateNodeContext,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ) => Node;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        default?: boolean | "key";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        format?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        identify?: (value: unknown) => boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        tag: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    createNode? +TagBase | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Interface TagBase

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      interface TagBase {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          createNode?: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              schema: Schema,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              value: unknown,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ctx: CreateNodeContext,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ) => Node;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          default?: boolean | "key";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          format?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          identify?: (value: unknown) => boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          tag: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      createNode? default? format? identify? tag

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      createNode?: (schema: Schema, value: unknown, ctx: CreateNodeContext) => Node

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      An optional factory function, used e.g. by collections when wrapping JS objects as AST nodes.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      default?: boolean | "key"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      If true, allows for values to be stringified without +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      default?: boolean | "key"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      If true, allows for values to be stringified without an explicit tag together with test. If 'key', this only applies if the value is used as a mapping key. For most cases, it's unlikely that you'll actually want to use this, even if you first think you do.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      format?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      If a tag has multiple forms that should be parsed and/or stringified +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      format?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      If a tag has multiple forms that should be parsed and/or stringified differently, use format to identify them.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      identify?: (value: unknown) => boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Used by YAML.createNode to detect your data type, e.g. using typeof or +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      identify?: (value: unknown) => boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Used by YAML.createNode to detect your data type, e.g. using typeof or instanceof.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      tag: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The identifier for your data type, with which its stringified form will be +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      tag: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The identifier for your data type, with which its stringified form will be prefixed. Should either be a !-prefixed local !tag, or a fully qualified tag:domain,date:foo.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/interfaces/_internal_.TagObject.html b/docs/interfaces/_internal_.TagObject.html index dc7ab06c..6519393f 100644 --- a/docs/interfaces/_internal_.TagObject.html +++ b/docs/interfaces/_internal_.TagObject.html @@ -1,4 +1,4 @@ -TagObject | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Interface TagObject

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        interface TagObject {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            description?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            externalDocs?: ExternalDocumentationObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            name: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            [extension: string]: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            [extensionName: `x-${string}`]: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Indexable

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        description? +TagObject | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Interface TagObject

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          interface TagObject {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              description?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              externalDocs?: ExternalDocumentationObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              name: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              [extension: string]: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              [extensionName: `x-${string}`]: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Indexable

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          description? externalDocs? name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          description?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          externalDocs?: ExternalDocumentationObject
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          name: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/interfaces/_internal_.TcpSocketConnectOpts.html b/docs/interfaces/_internal_.TcpSocketConnectOpts.html index cc25da8e..9496cca0 100644 --- a/docs/interfaces/_internal_.TcpSocketConnectOpts.html +++ b/docs/interfaces/_internal_.TcpSocketConnectOpts.html @@ -1,4 +1,4 @@ -TcpSocketConnectOpts | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Interface TcpSocketConnectOpts

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            interface TcpSocketConnectOpts {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                autoSelectFamily?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                autoSelectFamilyAttemptTimeout?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                blockList?: BlockList;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                family?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                hints?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                host?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                keepAlive?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                keepAliveInitialDelay?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                localAddress?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                localPort?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                lookup?: LookupFunction;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                noDelay?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                port: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            autoSelectFamily? +TcpSocketConnectOpts | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Interface TcpSocketConnectOpts

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              interface TcpSocketConnectOpts {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  autoSelectFamily?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  autoSelectFamilyAttemptTimeout?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  blockList?: BlockList;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  family?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  hints?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  host?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  keepAlive?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  keepAliveInitialDelay?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  localAddress?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  localPort?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  lookup?: LookupFunction;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  noDelay?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  port: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              autoSelectFamily? autoSelectFamilyAttemptTimeout? blockList? family? @@ -12,5 +12,5 @@ noDelay? port

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              autoSelectFamily?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              v18.13.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              autoSelectFamilyAttemptTimeout?: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              v18.13.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              blockList?: BlockList
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              family?: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              hints?: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              host?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              keepAlive?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              keepAliveInitialDelay?: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              localAddress?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              localPort?: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              lookup?: LookupFunction
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              noDelay?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              port: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              autoSelectFamilyAttemptTimeout?: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              v18.13.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              blockList?: BlockList
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              family?: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              hints?: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              host?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              keepAlive?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              keepAliveInitialDelay?: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              localAddress?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              localPort?: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              lookup?: LookupFunction
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              noDelay?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              port: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/interfaces/_internal_.TestOperation.html b/docs/interfaces/_internal_.TestOperation.html index 926d73e0..8dae6536 100644 --- a/docs/interfaces/_internal_.TestOperation.html +++ b/docs/interfaces/_internal_.TestOperation.html @@ -1,4 +1,4 @@ -TestOperation | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Interface TestOperation<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                interface TestOperation<T> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    op: "test";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    path: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    value: T;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                op +TestOperation | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Interface TestOperation<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  interface TestOperation<T> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      op: "test";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      path: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      value: T;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  op path value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  op: "test"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  path: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  value: T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/interfaces/_internal_.ToJSContext.html b/docs/interfaces/_internal_.ToJSContext.html index d0487d22..591ffb84 100644 --- a/docs/interfaces/_internal_.ToJSContext.html +++ b/docs/interfaces/_internal_.ToJSContext.html @@ -7,4 +7,4 @@ maxAliasCount onCreate?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  aliasResolveCache?: Node[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Cached anchor and alias nodes in the order they occur in the document

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  anchors: Map<Node, AnchorData>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  doc: Document<Node, boolean>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  keep: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  mapAsMap: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  mapKeyWarned: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  maxAliasCount: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  onCreate?: (res: unknown) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  anchors: Map<Node, AnchorData>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  doc: Document<Node, boolean>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  keep: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  mapAsMap: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  mapKeyWarned: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  maxAliasCount: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  onCreate?: (res: unknown) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Interface TraitsSchemaInternal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    A schema that has traits.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    use static schema.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    interface TraitsSchema {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        name: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        namespace: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        traits: SchemaTraits;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    name +namespace +traits +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    name: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    namespace: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    traits: SchemaTraits

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/interfaces/_internal_.URL.html b/docs/interfaces/_internal_.URL.html index 913f1d87..de9e9691 100644 --- a/docs/interfaces/_internal_.URL.html +++ b/docs/interfaces/_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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    interface URL {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        hash: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        host: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        hostname: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        href: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        origin: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        password: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        pathname: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        port: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        protocol: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        search: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        searchParams: URLSearchParams;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        username: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        toJSON(): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        toString(): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    hash +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    interface URL {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        hash: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        host: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        hostname: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        href: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        origin: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        password: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        pathname: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        port: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        protocol: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        search: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        searchParams: URLSearchParams;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        username: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        toJSON(): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        toString(): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    hash host hostname href @@ -28,18 +28,18 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Invalid URL characters included in the value assigned to the hash property are percent-encoded. The selection of which characters to percent-encode may vary somewhat from what the parse and format methods would produce.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    host: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Gets and sets the host portion of the URL.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    host: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Gets and sets the host portion of the URL.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    const myURL = new URL('https://example.org:81/foo');
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    console.log(myURL.host);
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    // Prints example.org:81

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    myURL.host = 'example.com:82';
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    console.log(myURL.href);
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    // Prints https://example.com:82/foo

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Invalid host values assigned to the host property are ignored.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    hostname: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Gets and sets the host name portion of the URL. The key difference betweenurl.host and url.hostname is that url.hostname does not include the +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    hostname: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Gets and sets the host name portion of the URL. The key difference betweenurl.host and url.hostname is that url.hostname does not include the port.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    const myURL = new URL('https://example.org:81/foo');
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    console.log(myURL.hostname);
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    // Prints example.org

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    // Setting the hostname does not change the port
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    myURL.hostname = 'example.com';
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    console.log(myURL.href);
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    // Prints https://example.com:81/foo

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    // Use myURL.host to change the hostname and port
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    myURL.host = 'example.org:82';
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    console.log(myURL.href);
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    // Prints https://example.org:82/foo

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Invalid host name values assigned to the hostname property are ignored.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    href: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Gets and sets the serialized URL.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    href: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Gets and sets the serialized URL.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    const myURL = new URL('https://example.org/foo');
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    console.log(myURL.href);
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    // Prints https://example.org/foo

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    myURL.href = 'https://example.com/bar';
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    console.log(myURL.href);
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    // Prints https://example.com/bar
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    @@ -47,27 +47,27 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Setting the value of this property to a new value is equivalent to creating a new URL object using new URL(value). Each of the URL object's properties will be modified.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    If the value assigned to the href property is not a valid URL, a TypeError will be thrown.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    origin: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Gets the read-only serialization of the URL's origin.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    origin: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Gets the read-only serialization of the URL's origin.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    const myURL = new URL('https://example.org/foo/bar?baz');
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    console.log(myURL.origin);
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    // Prints https://example.org
 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    const idnURL = new URL('https://測試');
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    console.log(idnURL.origin);
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    // Prints https://xn--g6w251d

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    console.log(idnURL.hostname);
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    // Prints xn--g6w251d
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    password: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Gets and sets the password portion of the URL.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    password: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Gets and sets the password portion of the URL.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    const myURL = new URL('https://abc:xyz@example.com');
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    console.log(myURL.password);
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    // Prints xyz

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    myURL.password = '123';
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    console.log(myURL.href);
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    // Prints https://abc:123@example.com/

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Invalid URL characters included in the value assigned to the password property are percent-encoded. The selection of which characters to percent-encode may vary somewhat from what the parse and format methods would produce.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    pathname: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Gets and sets the path portion of the URL.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    pathname: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Gets and sets the path portion of the URL.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    const myURL = new URL('https://example.org/abc/xyz?123');
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    console.log(myURL.pathname);
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    // Prints /abc/xyz

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    myURL.pathname = '/abcdef';
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    console.log(myURL.href);
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    // Prints https://example.org/abcdef?123

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Invalid URL characters included in the value assigned to the pathname property are percent-encoded. The selection of which characters to percent-encode may vary somewhat from what the parse and format methods would produce.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    port: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Gets and sets the port portion of the URL.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    port: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Gets and sets the port portion of the URL.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The port value may be a number or a string containing a number in the range 0 to 65535 (inclusive). Setting the value to the default port of the URL objects given protocol will result in the port value becoming the empty string ('').

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    @@ -90,18 +90,18 @@ 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    myURL.port = 4.567e21;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    console.log(myURL.port);
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    // Prints 4 (because it is the leading number in the string '4.567e21')
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    protocol: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Gets and sets the protocol portion of the URL.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    protocol: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Gets and sets the protocol portion of the URL.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    const myURL = new URL('https://example.org');
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    console.log(myURL.protocol);
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    // Prints https:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    myURL.protocol = 'ftp';
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    console.log(myURL.href);
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    // Prints ftp://example.org/

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Invalid URL protocol values assigned to the protocol property are ignored.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    search: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Gets and sets the serialized query portion of the URL.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    search: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Gets and sets the serialized query portion of the URL.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    const myURL = new URL('https://example.org/abc?123');
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    console.log(myURL.search);
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    // Prints ?123

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    myURL.search = 'abc=xyz';
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    console.log(myURL.href);
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    // Prints https://example.org/abc?abc=xyz

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Any invalid URL characters appearing in the value assigned the search property will be percent-encoded. The selection of which characters to percent-encode may vary somewhat from what the parse and format methods would produce.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    searchParams: URLSearchParams

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Gets the URLSearchParams object representing the query parameters of the +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    searchParams: URLSearchParams

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Gets the URLSearchParams object representing the query parameters of the URL. This property is read-only but the URLSearchParams object it provides can be used to mutate the URL instance; to replace the entirety of query parameters of the URL, use the search setter. See URLSearchParams documentation for details.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    @@ -113,19 +113,19 @@ 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    const myURL = new URL('https://example.org/abc?foo=~bar');

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    console.log(myURL.search);  // prints ?foo=~bar

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    // Modify the URL via searchParams...
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    myURL.searchParams.sort();

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    console.log(myURL.search);  // prints ?foo=%7Ebar
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    username: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Gets and sets the username portion of the URL.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    username: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Gets and sets the username portion of the URL.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    const myURL = new URL('https://abc:xyz@example.com');
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    console.log(myURL.username);
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    // Prints abc

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    myURL.username = '123';
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    console.log(myURL.href);
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    // Prints https://123:xyz@example.com/

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Any invalid URL characters appearing in the value assigned the username property will be percent-encoded. The selection of which characters to percent-encode may vary somewhat from what the parse and format methods would produce.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • The toJSON() method on the URL object returns the serialized URL. The +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • The toJSON() method on the URL object returns the serialized URL. The value returned is equivalent to that of href and toString.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      This method is automatically called when an URL object is serialized with JSON.stringify().

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      const myURLs = [
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        new URL('https://www.example.com'),
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        new URL('https://test.example.org'),
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      console.log(JSON.stringify(myURLs));
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      // Prints ["https://www.example.com/","https://test.example.org/"]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • The toString() method on the URL object returns the serialized URL. The +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • The toString() method on the URL object returns the serialized URL. The value returned is equivalent to that of href and toJSON.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/interfaces/_internal_.URLSearchParamsIterator.html b/docs/interfaces/_internal_.URLSearchParamsIterator.html index df175ccc..02104898 100644 --- a/docs/interfaces/_internal_.URLSearchParamsIterator.html +++ b/docs/interfaces/_internal_.URLSearchParamsIterator.html @@ -1,6 +1,6 @@ -URLSearchParamsIterator | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Interface URLSearchParamsIterator<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      interface URLSearchParamsIterator<T> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "[dispose]"(): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "[iterator]"(): URLSearchParamsIterator<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] +URLSearchParamsIterator | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Interface URLSearchParamsIterator<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        interface URLSearchParamsIterator<T> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            "[dispose]"(): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            "[iterator]"(): URLSearchParamsIterator<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? throw? -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • ...__namedParameters: [] | [unknown]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns IteratorResult<T, any>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • ...__namedParameters: [] | [unknown]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns IteratorResult<T, any>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Optionalvalue: any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns IteratorResult<T, any>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Optionale: any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns IteratorResult<T, any>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/interfaces/_internal_.UnderlyingByteSource.html b/docs/interfaces/_internal_.UnderlyingByteSource.html index 84c7b1c1..947bcac1 100644 --- a/docs/interfaces/_internal_.UnderlyingByteSource.html +++ b/docs/interfaces/_internal_.UnderlyingByteSource.html @@ -1,6 +1,6 @@ -UnderlyingByteSource | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Interface UnderlyingByteSource

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          interface UnderlyingByteSource {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              autoAllocateChunkSize?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              cancel?: ReadableStreamErrorCallback;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              pull?: ReadableByteStreamControllerCallback;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              start?: ReadableByteStreamControllerCallback;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              type: "bytes";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          autoAllocateChunkSize? +UnderlyingByteSource | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Interface UnderlyingByteSource

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            interface UnderlyingByteSource {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                autoAllocateChunkSize?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                cancel?: ReadableStreamErrorCallback;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                pull?: ReadableByteStreamControllerCallback;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                start?: ReadableByteStreamControllerCallback;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                type: "bytes";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            autoAllocateChunkSize? cancel? pull? start? type -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            autoAllocateChunkSize?: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            cancel?: ReadableStreamErrorCallback
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            pull?: ReadableByteStreamControllerCallback
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            start?: ReadableByteStreamControllerCallback
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            type: "bytes"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            autoAllocateChunkSize?: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            cancel?: ReadableStreamErrorCallback
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            pull?: ReadableByteStreamControllerCallback
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            start?: ReadableByteStreamControllerCallback
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            type: "bytes"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/interfaces/_internal_.UnderlyingSink.html b/docs/interfaces/_internal_.UnderlyingSink.html index bce6734c..e188451b 100644 --- a/docs/interfaces/_internal_.UnderlyingSink.html +++ b/docs/interfaces/_internal_.UnderlyingSink.html @@ -1,6 +1,6 @@ -UnderlyingSink | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Interface UnderlyingSink<W>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              interface UnderlyingSink<W = any> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  abort?: UnderlyingSinkAbortCallback;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  close?: UnderlyingSinkCloseCallback;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  start?: UnderlyingSinkStartCallback;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  type?: undefined;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  write?: UnderlyingSinkWriteCallback<W>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • W = any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              abort? +UnderlyingSink | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Interface UnderlyingSink<W>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                interface UnderlyingSink<W = any> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    abort?: UnderlyingSinkAbortCallback;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    close?: UnderlyingSinkCloseCallback;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    start?: UnderlyingSinkStartCallback;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    type?: undefined;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    write?: UnderlyingSinkWriteCallback<W>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • W = any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                abort? close? start? type? write? -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                abort?: UnderlyingSinkAbortCallback
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                close?: UnderlyingSinkCloseCallback
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                start?: UnderlyingSinkStartCallback
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                type?: undefined
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                write?: UnderlyingSinkWriteCallback<W>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                abort?: UnderlyingSinkAbortCallback
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                close?: UnderlyingSinkCloseCallback
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                start?: UnderlyingSinkStartCallback
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                type?: undefined
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                write?: UnderlyingSinkWriteCallback<W>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/interfaces/_internal_.UnderlyingSinkAbortCallback.html b/docs/interfaces/_internal_.UnderlyingSinkAbortCallback.html index 7c648a0a..cedbe4a6 100644 --- a/docs/interfaces/_internal_.UnderlyingSinkAbortCallback.html +++ b/docs/interfaces/_internal_.UnderlyingSinkAbortCallback.html @@ -1 +1 @@ -UnderlyingSinkAbortCallback | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Interface UnderlyingSinkAbortCallback

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Optionalreason: any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns void | PromiseLike<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +UnderlyingSinkAbortCallback | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Interface UnderlyingSinkAbortCallback

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Optionalreason: any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns void | PromiseLike<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/interfaces/_internal_.UnderlyingSinkCloseCallback.html b/docs/interfaces/_internal_.UnderlyingSinkCloseCallback.html index 917451ef..07237ee3 100644 --- a/docs/interfaces/_internal_.UnderlyingSinkCloseCallback.html +++ b/docs/interfaces/_internal_.UnderlyingSinkCloseCallback.html @@ -1 +1 @@ -UnderlyingSinkCloseCallback | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Interface UnderlyingSinkCloseCallback

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Returns void | PromiseLike<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +UnderlyingSinkCloseCallback | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Interface UnderlyingSinkCloseCallback

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Returns void | PromiseLike<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/interfaces/_internal_.UnderlyingSinkStartCallback.html b/docs/interfaces/_internal_.UnderlyingSinkStartCallback.html index 088961c9..ff4342bc 100644 --- a/docs/interfaces/_internal_.UnderlyingSinkStartCallback.html +++ b/docs/interfaces/_internal_.UnderlyingSinkStartCallback.html @@ -1 +1 @@ -UnderlyingSinkStartCallback | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Interface UnderlyingSinkStartCallback

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +UnderlyingSinkStartCallback | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Interface UnderlyingSinkStartCallback

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/interfaces/_internal_.UnderlyingSinkWriteCallback.html b/docs/interfaces/_internal_.UnderlyingSinkWriteCallback.html index 34d9906c..97a387db 100644 --- a/docs/interfaces/_internal_.UnderlyingSinkWriteCallback.html +++ b/docs/interfaces/_internal_.UnderlyingSinkWriteCallback.html @@ -1 +1 @@ -UnderlyingSinkWriteCallback | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Interface UnderlyingSinkWriteCallback<W>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • W

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +UnderlyingSinkWriteCallback | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Interface UnderlyingSinkWriteCallback<W>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • W

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/interfaces/_internal_.UnderlyingSource.html b/docs/interfaces/_internal_.UnderlyingSource.html index 60642954..2f0fd437 100644 --- a/docs/interfaces/_internal_.UnderlyingSource.html +++ b/docs/interfaces/_internal_.UnderlyingSource.html @@ -1,5 +1,5 @@ -UnderlyingSource | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Interface UnderlyingSource<R>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  interface UnderlyingSource<R = any> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      cancel?: UnderlyingSourceCancelCallback;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      pull?: UnderlyingSourcePullCallback<R>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      start?: UnderlyingSourceStartCallback<R>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      type?: undefined;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • R = any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  cancel? +UnderlyingSource | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Interface UnderlyingSource<R>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    interface UnderlyingSource<R = any> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        cancel?: UnderlyingSourceCancelCallback;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        pull?: UnderlyingSourcePullCallback<R>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        start?: UnderlyingSourceStartCallback<R>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        type?: undefined;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • R = any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    cancel? pull? start? type? -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    cancel?: UnderlyingSourceCancelCallback
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    pull?: UnderlyingSourcePullCallback<R>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    start?: UnderlyingSourceStartCallback<R>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    type?: undefined

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    cancel?: UnderlyingSourceCancelCallback
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    pull?: UnderlyingSourcePullCallback<R>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    start?: UnderlyingSourceStartCallback<R>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    type?: undefined

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/interfaces/_internal_.UnderlyingSourceCancelCallback.html b/docs/interfaces/_internal_.UnderlyingSourceCancelCallback.html index c8593fbe..54010479 100644 --- a/docs/interfaces/_internal_.UnderlyingSourceCancelCallback.html +++ b/docs/interfaces/_internal_.UnderlyingSourceCancelCallback.html @@ -1 +1 @@ -UnderlyingSourceCancelCallback | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Interface UnderlyingSourceCancelCallback

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Optionalreason: any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns void | PromiseLike<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +UnderlyingSourceCancelCallback | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Interface UnderlyingSourceCancelCallback

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Optionalreason: any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns void | PromiseLike<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/interfaces/_internal_.UnderlyingSourcePullCallback.html b/docs/interfaces/_internal_.UnderlyingSourcePullCallback.html index 4440a176..b2d3bf8c 100644 --- a/docs/interfaces/_internal_.UnderlyingSourcePullCallback.html +++ b/docs/interfaces/_internal_.UnderlyingSourcePullCallback.html @@ -1 +1 @@ -UnderlyingSourcePullCallback | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Interface UnderlyingSourcePullCallback<R>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • R

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +UnderlyingSourcePullCallback | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Interface UnderlyingSourcePullCallback<R>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • R

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/interfaces/_internal_.UnderlyingSourceStartCallback.html b/docs/interfaces/_internal_.UnderlyingSourceStartCallback.html index bc6a2946..3c3d7a4c 100644 --- a/docs/interfaces/_internal_.UnderlyingSourceStartCallback.html +++ b/docs/interfaces/_internal_.UnderlyingSourceStartCallback.html @@ -1 +1 @@ -UnderlyingSourceStartCallback | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Interface UnderlyingSourceStartCallback<R>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • R

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +UnderlyingSourceStartCallback | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Interface UnderlyingSourceStartCallback<R>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • R

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/interfaces/_internal_.UrlParser.html b/docs/interfaces/_internal_.UrlParser.html index 3dd9ec77..6f634d3d 100644 --- a/docs/interfaces/_internal_.UrlParser.html +++ b/docs/interfaces/_internal_.UrlParser.html @@ -1,2 +1,2 @@ UrlParser | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Interface UrlParser

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Parses a URL in string form into an Endpoint object.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • url: string | URL

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns Endpoint

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • url: string | URL

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns Endpoint

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/interfaces/_internal_.UserAgentInputConfig.html b/docs/interfaces/_internal_.UserAgentInputConfig.html index dea17d9c..4eab38db 100644 --- a/docs/interfaces/_internal_.UserAgentInputConfig.html +++ b/docs/interfaces/_internal_.UserAgentInputConfig.html @@ -1,5 +1,5 @@ UserAgentInputConfig | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Interface UserAgentInputConfig

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    interface UserAgentInputConfig {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        customUserAgent?: string | UserAgent;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        userAgentAppId?: string | Provider<string>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    customUserAgent? userAgentAppId?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    customUserAgent?: string | UserAgent

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The custom user agent header that would be appended to default one

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    userAgentAppId?: string | Provider<string>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The application ID used to identify the application.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    userAgentAppId?: string | Provider<string>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The application ID used to identify the application.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/interfaces/_internal_.WritableStream-1.html b/docs/interfaces/_internal_.WritableStream-1.html index e8d2be58..cffb0a2a 100644 --- a/docs/interfaces/_internal_.WritableStream-1.html +++ b/docs/interfaces/_internal_.WritableStream-1.html @@ -1,8 +1,8 @@ WritableStream | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Interface WritableStream<W>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      This Streams API interface provides a standard abstraction for writing streaming data to a destination, known as a sink. This object comes with built-in back pressure and queuing.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      interface WritableStream<W = any> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          locked: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          abort(reason?: any): Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          close(): Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          getWriter(): WritableStreamDefaultWriter<W>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • W = any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      locked +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      interface WritableStream<W = any> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          locked: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          abort(reason?: any): Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          close(): Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          getWriter(): WritableStreamDefaultWriter<W>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • W = any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      locked

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      abort close getWriter -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      locked: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Optionalreason: any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns Promise<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Returns Promise<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      locked: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Optionalreason: any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns Promise<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Returns Promise<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/interfaces/_internal_.WritableStream.html b/docs/interfaces/_internal_.WritableStream.html index 9bf113e4..5a86d158 100644 --- a/docs/interfaces/_internal_.WritableStream.html +++ b/docs/interfaces/_internal_.WritableStream.html @@ -1,4 +1,4 @@ -WritableStream | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Interface WritableStream

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        interface WritableStream {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            writable: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            "[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;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            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;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            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[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            removeAllListeners(eventName?: string | symbol): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            removeListener<K>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                eventName: string | symbol,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                listener: (...args: any[]) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            setMaxListeners(n: number): 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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        writable +WritableStream | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Interface WritableStream

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          interface WritableStream {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              writable: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              "[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;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              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;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              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[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              removeAllListeners(eventName?: string | symbol): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              removeListener<K>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  eventName: string | symbol,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  listener: (...args: any[]) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              setMaxListeners(n: number): 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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          writable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          [captureRejectionSymbol]? addListener emit @@ -17,38 +17,38 @@ removeListener setMaxListeners write -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          writable: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • K

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • error: Error
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • event: string | symbol
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • ...args: AnyRest

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Alias for emitter.on(eventName, listener).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          writable: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • K

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • error: Error
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • event: string | symbol
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • ...args: AnyRest

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Alias for emitter.on(eventName, listener).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • K

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • eventName: string | symbol
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • listener: (...args: any[]) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            v0.1.26

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns true if the event had listeners, false otherwise.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            import { EventEmitter } from 'node:events';
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            const myEmitter = new EventEmitter();

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            // First listener
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            myEmitter.on('event', function firstListener() {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              console.log('Helloooo! first listener');
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            });
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            // Second listener
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            myEmitter.on('event', function secondListener(arg1, arg2) {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              console.log(`event with parameters ${arg1}, ${arg2} in second listener`);
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            });
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            // Third listener
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            myEmitter.on('event', function thirdListener(...args) {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              const parameters = args.join(', ');
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              console.log(`event with parameters ${parameters} in third listener`);
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            });

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            console.log(myEmitter.listeners('event'));

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            myEmitter.emit('event', 1, 2, 3, 4, 5);

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            // Prints:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            // [
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            //   [Function: firstListener],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            //   [Function: secondListener],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            //   [Function: thirdListener]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            // ]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            // Helloooo! first listener
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            // event with parameters 1, 2 in second listener
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            // event with parameters 1, 2, 3, 4, 5 in third listener

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • K

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • eventName: string | symbol
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • ...args: AnyRest

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            v0.1.26

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Optionalcb: () => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Returns an array listing the events for which the emitter has registered +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Optionalcb: () => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Returns an array listing the events for which the emitter has registered listeners. The values in the array are strings or Symbols.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            import { EventEmitter } from 'node:events';

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            const myEE = new EventEmitter();
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            myEE.on('foo', () => {});
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            myEE.on('bar', () => {});

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            const sym = Symbol('symbol');
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            myEE.on(sym, () => {});

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            console.log(myEE.eventNames());
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            // Prints: [ 'foo', 'bar', Symbol(symbol) ]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns (string | symbol)[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            v6.0.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Returns the current max listener value for the EventEmitter which is either +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Returns the current max listener value for the EventEmitter which is either set by emitter.setMaxListeners(n) or defaults to EventEmitter.defaultMaxListeners.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            v1.0.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Returns the number of listeners listening for the event named eventName. +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Returns the number of listeners listening for the event named eventName. If listener is provided, it will return how many times the listener is found in the list of the listeners of the event.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • K

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • eventName: string | symbol

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The name of the event being listened for

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Optionallistener: Function

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The event handler function

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            v3.2.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Returns a copy of the array of listeners for the event named eventName.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Optionallistener: Function

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The event handler function

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          v3.2.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Returns a copy of the array of listeners for the event named eventName.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            server.on('connection', (stream) => {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              console.log('someone connected!');
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            });
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            console.log(util.inspect(server.listeners('connection')));
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            // Prints: [ [Function] ]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • K

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • eventName: string | symbol

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns Function[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            v0.1.26

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Alias for emitter.removeListener().

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Alias for emitter.removeListener().

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • K

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • eventName: string | symbol
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • listener: (...args: any[]) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            v10.0.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Adds the listener function to the end of the listeners array for the event +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Adds the listener function to the end of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            @@ -62,9 +62,9 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • K

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • eventName: string | symbol

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The name of the event.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • listener: (...args: any[]) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The callback function

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            v0.1.101

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Adds a one-time listener function for the event named eventName. The +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • listener: (...args: any[]) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The callback function

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          v0.1.101

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Adds a one-time listener function for the event named eventName. The next time eventName is triggered, this listener is removed and then invoked.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            server.once('connection', (stream) => {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              console.log('Ah, we have our first user!');
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            });
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            @@ -76,9 +76,9 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • K

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • eventName: string | symbol

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The name of the event.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • listener: (...args: any[]) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The callback function

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            v0.3.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Adds the listener function to the beginning of the listeners array for the +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • listener: (...args: any[]) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The callback function

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          v0.3.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Adds the listener function to the beginning of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            @@ -87,30 +87,30 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns a reference to the EventEmitter, so that calls can be chained.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • K

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • eventName: string | symbol

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The name of the event.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • listener: (...args: any[]) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The callback function

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            v6.0.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Adds a one-timelistener function for the event named eventName to the beginning of the listeners array. The next time eventName is triggered, this +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • listener: (...args: any[]) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The callback function

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          v6.0.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Adds a one-timelistener function for the event named eventName to the beginning of the listeners array. The next time eventName is triggered, this listener is removed, and then invoked.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            server.prependOnceListener('connection', (stream) => {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              console.log('Ah, we have our first user!');
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            });

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns a reference to the EventEmitter, so that calls can be chained.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • K

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • eventName: string | symbol

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The name of the event.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • listener: (...args: any[]) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The callback function

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            v6.0.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Returns a copy of the array of listeners for the event named eventName, +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • listener: (...args: any[]) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The callback function

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          v6.0.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Returns a copy of the array of listeners for the event named eventName, including any wrappers (such as those created by .once()).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            import { EventEmitter } from 'node:events';
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            const emitter = new EventEmitter();
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            emitter.once('log', () => console.log('log once'));

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            // Returns a new Array with a function `onceWrapper` which has a property
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            // `listener` which contains the original listener bound above
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            const listeners = emitter.rawListeners('log');
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            const logFnWrapper = listeners[0];

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            // Logs "log once" to the console and does not unbind the `once` event
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            logFnWrapper.listener();

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            // Logs "log once" to the console and removes the listener
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            logFnWrapper();

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            emitter.on('log', () => console.log('log persistently'));
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            // Will return a new Array with a single function bound by `.on()` above
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            const newListeners = emitter.rawListeners('log');

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            // Logs "log persistently" twice
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            newListeners[0]();
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            emitter.emit('log');

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • K

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • eventName: string | symbol

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns Function[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            v9.4.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Removes all listeners, or those of the specified eventName.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Removes all listeners, or those of the specified eventName.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            It is bad practice to remove listeners added elsewhere in the code, particularly when the EventEmitter instance was created by some other component or module (e.g. sockets or file streams).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns a reference to the EventEmitter, so that calls can be chained.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • OptionaleventName: string | symbol

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            v0.1.26

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Removes the specified listener from the listener array for the event named eventName.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Removes the specified listener from the listener array for the event named eventName.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            const callback = (stream) => {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              console.log('someone connected!');
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            server.on('connection', callback);
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            // ...
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            server.removeListener('connection', callback);
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            @@ -137,10 +137,10 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns a reference to the EventEmitter, so that calls can be chained.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • K

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • eventName: string | symbol
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • listener: (...args: any[]) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            v0.1.26

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • By default EventEmitters will print a warning if more than 10 listeners are +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • By default EventEmitters will print a warning if more than 10 listeners are added for a particular event. This is a useful default that helps finding memory leaks. The emitter.setMaxListeners() method allows the limit to be modified for this specific EventEmitter instance. The value can be set to Infinity (or 0) to indicate an unlimited number of listeners.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns a reference to the EventEmitter, so that calls can be chained.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • n: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            v0.3.5

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • buffer: string | Uint8Array<ArrayBufferLike>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Optionalcb: (err?: Error) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • str: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Optionalencoding: BufferEncoding
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Optionalcb: (err?: Error) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • buffer: string | Uint8Array<ArrayBufferLike>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Optionalcb: (err?: Error) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • str: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Optionalencoding: BufferEncoding
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Optionalcb: (err?: Error) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/interfaces/_internal_.WritableStreamDefaultController.html b/docs/interfaces/_internal_.WritableStreamDefaultController.html index 69fe29fe..1c23d6be 100644 --- a/docs/interfaces/_internal_.WritableStreamDefaultController.html +++ b/docs/interfaces/_internal_.WritableStreamDefaultController.html @@ -2,5 +2,5 @@ WritableStream's state. When constructing a WritableStream, the underlying sink is given a corresponding WritableStreamDefaultController instance to manipulate.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          interface WritableStreamDefaultController {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              error(e?: any): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          error -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Optionale: any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          interface WritableStreamDefaultController {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              error(e?: any): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          error +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Optionale: any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/interfaces/_internal_.WritableStreamDefaultWriter.html b/docs/interfaces/_internal_.WritableStreamDefaultWriter.html index a942aab1..79cb6402 100644 --- a/docs/interfaces/_internal_.WritableStreamDefaultWriter.html +++ b/docs/interfaces/_internal_.WritableStreamDefaultWriter.html @@ -2,11 +2,11 @@ WritableStream.getWriter() and once created locks the < writer to the WritableStream ensuring that no other streams can write to the underlying sink.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          interface WritableStreamDefaultWriter<W = any> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              closed: Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              desiredSize: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ready: Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              abort(reason?: any): Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              close(): Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              releaseLock(): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              write(chunk?: W): Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • W = any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          closed +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          interface WritableStreamDefaultWriter<W = any> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              closed: Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              desiredSize: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ready: Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              abort(reason?: any): Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              close(): Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              releaseLock(): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              write(chunk?: W): Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • W = any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          closed desiredSize ready

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          abort close releaseLock write -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          closed: Promise<void>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          desiredSize: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ready: Promise<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Optionalreason: any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns Promise<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Returns Promise<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Optionalchunk: W

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns Promise<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          closed: Promise<void>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          desiredSize: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ready: Promise<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Optionalreason: any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns Promise<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Returns Promise<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Optionalchunk: W

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns Promise<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/interfaces/_internal_.XmlObject.html b/docs/interfaces/_internal_.XmlObject.html index c1e30e99..a8c47d20 100644 --- a/docs/interfaces/_internal_.XmlObject.html +++ b/docs/interfaces/_internal_.XmlObject.html @@ -1,4 +1,4 @@ -XmlObject | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Interface XmlObject

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            interface XmlObject {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                attribute?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                name?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                namespace?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                prefix?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                wrapped?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                [extensionName: `x-${string}`]: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Indexable

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            attribute? +XmlObject | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Interface XmlObject

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              interface XmlObject {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  attribute?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  name?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  namespace?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  prefix?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  wrapped?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  [extensionName: `x-${string}`]: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Indexable

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              attribute? name? namespace? prefix? diff --git a/docs/interfaces/_internal_._S3HttpAuthSchemeParameters.html b/docs/interfaces/_internal_._S3HttpAuthSchemeParameters.html index c746444c..2cc31000 100644 --- a/docs/interfaces/_internal_._S3HttpAuthSchemeParameters.html +++ b/docs/interfaces/_internal_._S3HttpAuthSchemeParameters.html @@ -1,3 +1,3 @@ -_S3HttpAuthSchemeParameters | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Interface _S3HttpAuthSchemeParametersInternal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                interface _S3HttpAuthSchemeParameters {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    operation?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    region?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                operation? +_S3HttpAuthSchemeParameters | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Interface _S3HttpAuthSchemeParametersInternal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  interface _S3HttpAuthSchemeParameters {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      operation?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      region?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  operation? region?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  operation?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  region?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/modules.html b/docs/modules.html index 3711bac8..22b39a66 100644 --- a/docs/modules.html +++ b/docs/modules.html @@ -1 +1 @@ -ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Modules

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      <internal>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Enumerations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      LogLevel

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Classes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ApiApp
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ApiError
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ApiLambdaApp
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ApiRequest
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ApiResponse
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      AppConfig
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      BasicAuth
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      BasicAuthFilter
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Controller
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ErrorInterceptor
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      LogFactory
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      MiddlewareRegistry
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      OpenApiConfig
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Principal
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      RequestBuilder
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Server
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ServerLoggerConfig

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Interfaces

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      IAuthFilter
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      IAuthorizer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      IDictionary
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ILogger

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Aliases

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      JsonPatch
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      LogFormat

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      api
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      apiController
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      apiIgnore
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      apiIgnoreController
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      apiOperation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      apiRequest
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      apiResponse
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      apiSecurity
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      body
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      consumes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      controllerConsumes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      controllerErrorInterceptor
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      controllerNoAuth
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      controllerProduces
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      controllerRolesAllowed
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      DELETE
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      errorInterceptor
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      GET
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      noAuth
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      PATCH
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      pathParam
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      POST
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      principal
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      produces
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      PUT
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      queryParam
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      rawBody
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      request
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      response
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      rolesAllowed
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      timed

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Modules
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Enumerations
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Classes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Interfaces
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Aliases
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Functions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Modules

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          <internal>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Enumerations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          LogLevel

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Classes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ApiApp
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ApiError
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ApiLambdaApp
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ApiRequest
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ApiResponse
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          AppConfig
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          BasicAuth
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          BasicAuthFilter
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Controller
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ErrorInterceptor
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          LogFactory
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          MiddlewareRegistry
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          OpenApiConfig
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Principal
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          RequestBuilder
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Server
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ServerLoggerConfig

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Interfaces

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          IAuthFilter
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          IAuthorizer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          IDictionary
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ILogger

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Aliases

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          JsonPatch
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          LogFormat

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          api
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          apiController
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          apiIgnore
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          apiIgnoreController
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          apiOperation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          apiRequest
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          apiResponse
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          apiSecurity
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          body
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          consumes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          controllerConsumes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          controllerErrorInterceptor
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          controllerNoAuth
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          controllerProduces
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          controllerRolesAllowed
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          DELETE
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          errorInterceptor
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          GET
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          noAuth
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          PATCH
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          pathParam
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          POST
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          principal
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          produces
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          PUT
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          queryParam
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          rawBody
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          request
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          response
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          rolesAllowed
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          timed

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Modules
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Enumerations
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Classes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Interfaces
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Aliases
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Functions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/modules/_internal_.Alias.html b/docs/modules/_internal_.Alias.html index 9f377147..cd9a34da 100644 --- a/docs/modules/_internal_.Alias.html +++ b/docs/modules/_internal_.Alias.html @@ -1 +1 @@ -Alias | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Namespace Alias

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            References

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parsed → Parsed

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            References
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +Alias | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Namespace Alias

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              References

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Parsed → Parsed

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              References
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/modules/_internal_.EventEmitter.html b/docs/modules/_internal_.EventEmitter.html index d3c75a86..42ca84f7 100644 --- a/docs/modules/_internal_.EventEmitter.html +++ b/docs/modules/_internal_.EventEmitter.html @@ -1 +1 @@ -EventEmitter | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Namespace EventEmitter

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Classes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                EventEmitterAsyncResource

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Interfaces

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Abortable
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                EventEmitterAsyncResourceOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                EventEmitterReferencingAsyncResource

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                References

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                EventEmitter → EventEmitter

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Classes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Interfaces
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                References
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +EventEmitter | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Namespace EventEmitter

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Classes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  EventEmitterAsyncResource

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Interfaces

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Abortable
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  EventEmitterAsyncResourceOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  EventEmitterReferencingAsyncResource
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  NodeEventTarget

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  References

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  EventEmitter → EventEmitter

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Classes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Interfaces
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  References
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/modules/_internal_.Scalar.html b/docs/modules/_internal_.Scalar.html index 195a5c0b..3d6bb9e3 100644 --- a/docs/modules/_internal_.Scalar.html +++ b/docs/modules/_internal_.Scalar.html @@ -1 +1 @@ -Scalar | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Namespace Scalar

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Aliases

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    BLOCK_FOLDED
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    BLOCK_LITERAL
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    PLAIN
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    QUOTE_DOUBLE
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    QUOTE_SINGLE

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    BLOCK_FOLDED
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    BLOCK_LITERAL
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    PLAIN
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    QUOTE_DOUBLE
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    QUOTE_SINGLE

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    References

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parsed → Parsed
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type → Type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Aliases
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Variables
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    References
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +Scalar | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Namespace Scalar

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Aliases

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      BLOCK_FOLDED
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      BLOCK_LITERAL
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      PLAIN
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      QUOTE_DOUBLE
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      QUOTE_SINGLE

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      BLOCK_FOLDED
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      BLOCK_LITERAL
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      PLAIN
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      QUOTE_DOUBLE
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      QUOTE_SINGLE

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      References

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Parsed → Parsed
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type → Type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Aliases
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Variables
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      References
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/modules/_internal_.Stream.html b/docs/modules/_internal_.Stream.html index b9c51331..4d609470 100644 --- a/docs/modules/_internal_.Stream.html +++ b/docs/modules/_internal_.Stream.html @@ -1 +1 @@ -Stream | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Namespace Stream

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Modules

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        node:stream/promises

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Namespaces

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        finished
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        pipeline

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Classes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Duplex
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        PassThrough
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Transform
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Writable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Interfaces

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ArrayOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        DuplexOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        FinishedOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Pipe
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        PipelineOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ReadableOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        StreamOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        TransformOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        WritableOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Aliases

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        PipelineCallback
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        PipelineDestination
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        PipelineDestinationIterableFunction
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        PipelineDestinationPromiseFunction
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        PipelinePromise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        PipelineSource
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        PipelineSourceFunction
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        PipelineTransform
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        PipelineTransformSource
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        TransformCallback

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        addAbortSignal
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        duplexPair
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        finished
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        getDefaultHighWaterMark
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        isErrored
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        isReadable
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        pipeline
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        setDefaultHighWaterMark

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        References

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Readable → Readable
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Stream → Stream

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Modules
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Namespaces
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Classes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Interfaces
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Aliases
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Functions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        References
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +Stream | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Namespace Stream

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Modules

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          node:stream/promises

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Namespaces

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          finished
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          pipeline

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Classes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Duplex
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          PassThrough
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Transform
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Writable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Interfaces

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ArrayOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          DuplexOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          FinishedOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Pipe
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          PipelineOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ReadableOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          StreamOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          TransformOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          WritableOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Aliases

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          PipelineCallback
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          PipelineDestination
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          PipelineDestinationIterableFunction
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          PipelineDestinationPromiseFunction
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          PipelinePromise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          PipelineSource
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          PipelineSourceFunction
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          PipelineTransform
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          PipelineTransformSource
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          TransformCallback

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          addAbortSignal
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          duplexPair
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          finished
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          getDefaultHighWaterMark
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          isErrored
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          isReadable
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          isWritable
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          pipeline
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          setDefaultHighWaterMark

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          References

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Readable → Readable
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Stream → Stream

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Modules
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Namespaces
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Classes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Interfaces
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Aliases
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Functions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          References
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/modules/_internal_.YAMLMap.html b/docs/modules/_internal_.YAMLMap.html index ee45a195..008dda47 100644 --- a/docs/modules/_internal_.YAMLMap.html +++ b/docs/modules/_internal_.YAMLMap.html @@ -1 +1 @@ -YAMLMap | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Namespace YAMLMap

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            References

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parsed → Parsed

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            References
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +YAMLMap | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Namespace YAMLMap

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              References

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Parsed → Parsed

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              References
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/modules/_internal_.YAMLSeq.html b/docs/modules/_internal_.YAMLSeq.html index 9a875706..2db50085 100644 --- a/docs/modules/_internal_.YAMLSeq.html +++ b/docs/modules/_internal_.YAMLSeq.html @@ -1 +1 @@ -YAMLSeq | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Namespace YAMLSeq

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                References

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Parsed → Parsed

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                References
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +YAMLSeq | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Namespace YAMLSeq

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  References

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Parsed → Parsed

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  References
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/modules/_internal_.html b/docs/modules/_internal_.html index 7d8781f0..b6fa478f 100644 --- a/docs/modules/_internal_.html +++ b/docs/modules/_internal_.html @@ -1 +1 @@ -<internal> | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Module <internal>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Namespaces

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Alias
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Document
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    EventEmitter
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Scalar
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Stream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    YAMLMap
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    YAMLSeq

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Enumerations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    AlgorithmId

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Classes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Agent
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Agent
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Alias
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    API
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ApiBody
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ApiBodyInfo
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ApiOperation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ApiOperationInfo
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ApiParam
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    AsyncResource
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    AuthFilterInfo
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Blob
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    BlockList
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ClientRequest
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Collection
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Container
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ContainerModule
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ControllerInfo
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Directives
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Document
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    EndpointInfo
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    EventEmitter
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Headers
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    HttpRequest
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    HttpResponse
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    IncomingMessage
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    LazyServiceIdentifier
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    LineCounter
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    NodeBase
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    OpenApiBuilder
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    OpenApiGenerator
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    OutgoingMessage
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Pair
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Readable
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Request
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Response
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Scalar
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Schema
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Socket
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    SocketAddress
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Stream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    URL
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    URLSearchParams
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    YAMLError
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    YAMLMap
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    YAMLSeq
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    YAMLWarning

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Interfaces

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    _S3HttpAuthSchemeParameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    AbortHandler
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    AbortSignal
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    AbortSignal
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    AddEventListenerOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    AddOperation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    AddressInfo
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    AgentOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    AgentOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    AnchorData
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    APIGatewayEventClientCertificate
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    APIGatewayEventIdentity
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    APIGatewayEventRequestContextV2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    APIGatewayEventRequestContextWithAuthorizer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    APIGatewayProxyEventBase
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    APIGatewayProxyEventHeaders
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    APIGatewayProxyEventMultiValueHeaders
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    APIGatewayProxyEventMultiValueQueryStringParameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    APIGatewayProxyEventPathParameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    APIGatewayProxyEventQueryStringParameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    APIGatewayProxyEventStageVariables
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    APIGatewayProxyEventV2WithRequestContext
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    App
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ArrayBufferView
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ArrayIterator
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ArrayLike
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    AsyncGenerator
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    AsyncGeneratorFunction
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    AsyncIterable
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    AsyncIterableIterator
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    AsyncIterator
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    AsyncResourceOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    AuthScheme
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    AwsCredentialIdentity
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    AwsRegionExtensionConfiguration
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    AwsSdkSigV4AAuthInputConfig
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    AwsSdkSigV4AuthInputConfig
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    BaseMultipleResolvedValueMetadataInjectOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    BaseOperation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    BaseOptionalResolvedValueMetadataInjectOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    BaseParameterObject
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    BaseResolvedValueMetadataInjectOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    BindInFluentSyntax
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    BindingConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    BindingIdentifier
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    BindInWhenOnFluentSyntax
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    BindOnFluentSyntax
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    BindToFluentSyntax
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    BindWhenFluentSyntax
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    BindWhenOnFluentSyntax
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    BlobOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    BlockMap
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    BlockScalar
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    BlockSequence
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    BodyLengthCalculator
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    BoundServiceSyntax
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    CallbackObject
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    CallbacksObject
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    CallSite
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Certificate
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Checksum
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ChecksumAlgorithm
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ChecksumConfiguration
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ChecksumConstructor
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ClientContext
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ClientContextClient
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ClientContextEnv
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ClientDefaults
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ClientInputEndpointParameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ClientRequestArgs
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    CognitoIdentity
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    CollectionTag
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    CommonConnectionOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ComponentsObject
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ConnectionOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ContactObject
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ContainerModuleLoadOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ContainerOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ContentObject
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Context
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    CookieOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    CopyOperation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    CorsOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    CreateNodeContext
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Decoder
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    DefaultExtensionConfiguration
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    DeserializeHandlerOutput
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Dict
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Directive
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    DiscriminatorObject
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Disposable
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Document
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    DocumentEnd
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Encoder
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    EncodingObject
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Endpoint
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    EndpointInputConfig
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    EndpointParameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    EndpointV2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ErrnoException
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ErrorHandler
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ErrorToken
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Event
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Event
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    EventEmitter
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    EventEmitterOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    EventInit
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    EventListener
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    EventListenerObject
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    EventListenerOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    EventStreamMarshaller
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    EventStreamMarshallerDeserFn
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    EventStreamMarshallerSerFn
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    EventStreamSerdeInputConfig
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    EventStreamSerdeProvider
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    EventTarget
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    EventTarget
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ExampleObject
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ExamplesObject
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ExternalDocumentationObject
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    FetchHttpHandlerOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    FileOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    FinalizeHandler
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    FinalizeHandlerArguments
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    FinalizeHandlerOutput
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    FlexibleChecksumsInputConfig
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Float16Array
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Float16ArrayConstructor
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    FlowCollection
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    FlowScalar
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    GetAllOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    GetAwsChunkedEncodingStream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    GetAwsChunkedEncodingStreamOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    GetOperation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    GetOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    GetOptionsTagConstraint
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Hash
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    HashConstructor
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    HeaderObject
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Headers
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    HeadersObject
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    HostHeaderInputConfig
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    HttpAuthExtensionConfiguration
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    HttpAuthOption
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    HttpAuthScheme
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    HttpAuthSchemeInputConfig
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    HttpAuthSchemeParameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    HttpAuthSchemeProvider
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    HttpHandlerExtensionConfiguration
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    HttpHandlerOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    HttpMessage
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    HttpRequest
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    HttpResponse
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    HttpSigner
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Identity
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    IdentityProvider
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    IdentityProviderConfig
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    IncomingHttpHeaders
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    InfoObject
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    InformationEvent
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    InitializeHandlerArguments
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    InitializeHandlerOutput
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Int64
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    IParameterExtractor
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    IpcSocketConnectOpts
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    IsBoundOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Iterable
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Iterator
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    IteratorReturnResult
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    IteratorYieldResult
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    KeyObject
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    LicenseObject
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    LinkObject
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    LinkParametersObject
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    LinksObject
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Logger
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    LoggerOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    LookupAddress
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    LookupOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    MediaTypeObject
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Message
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    MetadataBearer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    MoveOperation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    MultipleOptionalResolvedValueMetadataInjectOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    MultipleResolvedValueMetadataInjectOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    NodeHttpHandlerOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    OAuthFlowObject
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    OAuthFlowsObject
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    OnReadOpts
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    OpenAPIObject
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    OperationObject
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    OptionalGetOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    OptionalResolvedValueMetadataInjectOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Options
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    OutgoingHttpHeaders
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ParameterObject
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parsed
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parsed
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parsed
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parsed
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    PathItemObject
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    PathsObject
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    PeerCertificate
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    PromiseLike
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    PropertyDescriptor
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Provider
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    PSKCallbackNegotation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    PxfObject
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    QueuingStrategy
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    QueuingStrategySize
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ReadableByteStreamController
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ReadableByteStreamControllerCallback
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ReadableStream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ReadableStream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ReadableStreamAsyncIterator
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ReadableStreamBYOBReader
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ReadableStreamDefaultController
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ReadableStreamDefaultReader
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ReadableStreamErrorCallback
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ReadableStreamGenericReader
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ReadableStreamGetReaderOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ReadableStreamReadDoneResult
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ReadableStreamReadValueResult
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ReadableWritablePair
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ReadOnlyDict
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ReadWriteStream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ReferenceObject
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    RegionInputConfig
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    RegisterOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    RemoveOperation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ReplaceOperation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    RequestBodyObject
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    RequestHandler
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    RequestHandlerMetadata
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    RequestSigner
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    RequestSigningArguments
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ResolutionContext
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ResolvedValueMetadataInjectTagOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ResponseMetadata
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ResponseObject
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ResponsesObject
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    RetryableTrait
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    RetryErrorInfo
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    RetryInputConfig
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    RetryStrategy
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    RetryStrategyConfiguration
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    RetryStrategyV2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    RetryToken
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    RuntimeExtension
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    S3ClientConfig
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    S3ExpressIdentity
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    S3ExpressIdentityProvider
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    S3ExtensionConfiguration
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    S3HttpAuthSchemeParameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    S3HttpAuthSchemeProvider
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    S3InputConfig
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    SamplingOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ScalarTag
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    SchemaObject
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ScopesObject
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    SdkStreamMixin
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    SdkStreamMixinInjector
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    SecureContext
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    SecureContextOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    SecurityRequirementObject
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    SecuritySchemeObject
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    SerializeHandlerArguments
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ServerObject
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ServerVariableObject
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    SignatureV4CryptoInit
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    SignatureV4Init
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    SigningArguments
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    SmithyConfiguration
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    SmithyException
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    SocketAddressInitOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    SocketConstructorOpts
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    SourceToken
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    SpecIterable
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    SpecIterableIterator
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    SpecIterator
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    StaticEventEmitterIteratorOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    StaticEventEmitterOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    StreamCollector
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    StreamHasher
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    StreamPipeOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    SuccessHandler
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    TagBase
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    TagObject
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    TcpSocketConnectOpts
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    TestOperation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ToJSContext
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    UnderlyingByteSource
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    UnderlyingSink
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    UnderlyingSinkAbortCallback
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    UnderlyingSinkCloseCallback
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    UnderlyingSinkStartCallback
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    UnderlyingSinkWriteCallback
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    UnderlyingSource
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    UnderlyingSourceCancelCallback
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    UnderlyingSourcePullCallback
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    UnderlyingSourceStartCallback
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    URL
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    UrlParser
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    URLSearchParamsIterator
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    UserAgentInputConfig
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    WritableStream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    WritableStream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    WritableStreamDefaultController
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    WritableStreamDefaultWriter
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    XmlObject

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Aliases

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    __Event
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    __EventTarget
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    _Headers
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    AbstractNewable
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    AnyRest
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    APIGatewayEventDefaultAuthorizerContext
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    APIGatewayEventRequestContext
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    APIGatewayProxyEvent
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    APIGatewayProxyEventV2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Args
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ArrayBufferLike
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ArrayBufferView
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Autocomplete
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    AutocompletePrimitiveBaseType
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    AwsCredentialIdentityProvider
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    BinaryHeaderValue
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    BinaryLike
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Bind
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    BindingActivation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    BindingDeactivation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    BindingScope
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    BooleanHeaderValue
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    BufferEncoding
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    BuiltinIteratorReturn
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    BuiltinIteratorReturn
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ByteHeaderValue
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ChecksumConfigurationLegacy
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    CollectionItem
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ComposeFnParam
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    CreateNodeOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    DateInput
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    DefaultEventMap
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    DefaultsMode
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    DocumentOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    DynamicValueBuilder
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    EndpointObjectProperty
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    EndpointParameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ErrorCallback
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ErrorCode
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ErrorHandlingMiddleware
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    EventMap
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Exclude
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Factory
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    FinallyFunction
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    HandlerFunction
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    HeaderBag
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    HeaderNames
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    HeaderRecord
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    HeadersInit
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    HeaderValue
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    HttpHandler
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    HttpHandlerUserInput
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    HttpRequestOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    HttpResponseOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    IANARegisteredMimeType
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    IntegerHeaderValue
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    IPVersion
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    IsBound
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ISpecificationExtension
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    IteratorResult
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Key
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Key2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    KnownHeaderValues
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    LinePos
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Listener
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    LoggerFunction
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    LoggerFunctionAdditionalInfo
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    LogLevelId
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    LongHeaderValue
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    LookupFunction
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Lowercase
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    MapLike
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    MapToResolvedValueInjectOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    MessageHeaders
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    MessageHeaderValue
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    MetadataName
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    MetadataTag
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    METHODS
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Middleware
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Newable
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    NextFunction
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Node
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    NodeType
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Omit
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    OnActivation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    OnDeactivation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    OpenApiFormat
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Operation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    OutgoingHttpHeader
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ParameterLocation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ParameterSource
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ParameterStyle
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ParsedNode
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ParseOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Partial
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Pick
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    PropertyKey
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Provider
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    QueryParameterBag
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Range
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ReadableStreamController
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ReadableStreamReader
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ReadableStreamReadResult
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Readonly
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Rebind
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    RebindSync
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Record
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Replacer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    RequestChecksumCalculation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    RequestHandlerOutput
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Required
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Resolved
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ResolvedValueInjectOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ResolvedValueMetadataInjectOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ResponseChecksumValidation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    RetryErrorType
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ReturnType
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Reviver
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    S3ClientConfigType
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    SchemaObjectType
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    SchemaOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    SdkError
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    SecureVersion
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    SecuritySchemeType
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    SerializerFunction
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ServiceIdentifier
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ShortHeaderValue
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    SocketConnectOpts
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    SocketReadyState
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    SourceData
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    StringHeaderValue
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    StringifyContext
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    SyncResolved
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    TagId
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Tags
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    TimestampFunction
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    TimestampHeaderValue
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ToJSOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Token
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ToStringOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    TypedArray
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Unbind
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    UnbindSync
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    URI
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    UserAgent
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    UserAgentPair
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    UuidHeaderValue

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    AbortSignal
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Event
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    EventTarget
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Float16Array
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Headers
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ReadableByteStreamController
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ReadableStream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ReadableStreamBYOBReader
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ReadableStreamDefaultController
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ReadableStreamDefaultReader
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    RequestChecksumCalculation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ResponseChecksumValidation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    tagsByName
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    URL
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    WritableStream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    WritableStreamDefaultController
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    WritableStreamDefaultWriter

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    _construct
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    _construct
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    _destroy
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    _destroy
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    _final
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    _write
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    _writev
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    add
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    add
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    add
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    addIn
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    addListener
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    addListener
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    addListener
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    addListener
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    addTrailers
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    appendHeader
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    authenticate
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    bind
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    clone
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    compose
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    configureApi
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    configureApp
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    construct
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    createAlias
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    createConnection
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    createNode
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    createPair
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    delete
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    delete
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    delete
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    deleteIn
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    destroy
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    destroy
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    destroy
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    emit
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    emit
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    emit
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    emit
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    emitDestroy
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    end
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    end
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    eventNames
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    every
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    extractAuthData
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    filter
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    final
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    find
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    flatMap
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    flushHeaders
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    forEach
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    get
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    get
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    get
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    getHeader
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    getHeaderNames
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    getHeaders
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    getIn
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    getMaxListeners
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    has
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    has
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    has
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    hasHeader
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    hasIn
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    httpHandler
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    httpHandlerConfigs
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    initialiseControllers
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    inRequestScope
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    inSingletonScope
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    inTransientScope
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    iterator
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    listenerCount
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    listeners
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    map
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    next
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    next
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    next
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    off
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    on
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    on
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    on
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    on
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    onActivation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    once
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    once
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    once
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    once
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    onDeactivation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    pause
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    pause
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    pipe
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    pipe
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    prependListener
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    prependListener
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    prependListener
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    prependListener
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    prependOnceListener
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    prependOnceListener
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    prependOnceListener
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    prependOnceListener
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    rawListeners
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    read
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    read
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    reduce
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    removeAllListeners
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    removeHeader
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    removeListener
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    removeListener
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    removeListener
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    removeListener
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    resolve
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    resume
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    resume
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    return
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    return
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    runInAsyncScope
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    set
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    set
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    set
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    setDefaultEncoding
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    setEncoding
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    setEncoding
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    setHeader
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    setHeaders
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    setHttpHandler
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    setIn
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    setMaxListeners
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    setSchema
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    setTimeout
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    some
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    throw
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    throw
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    toJS
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    toJSON
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    toJSON
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    toJSON
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    toJSON
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    toString
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    toString
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    toString
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    toString
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    toString
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    toString
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    unpipe
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    unpipe
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    unshift
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    updateHttpClientConfig
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    when
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    whenAnyAncestor
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    whenAnyAncestorIs
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    whenAnyAncestorNamed
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    whenAnyAncestorTagged
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    whenDefault
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    whenNamed
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    whenNoAncestor
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    whenNoAncestorIs
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    whenNoAncestorNamed
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    whenNoAncestorTagged
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    whenNoParent
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    whenNoParentIs
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    whenNoParentNamed
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    whenNoParentTagged
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    whenParent
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    whenParentIs
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    whenParentNamed
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    whenParentTagged
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    whenTagged
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    wrap
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    wrap
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    write
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    write
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    write
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    writev

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    References

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Abortable → EventEmitter.Abortable
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ArrayOptions → Stream.ArrayOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ReadableOptions → Stream.ReadableOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Namespaces
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Enumerations
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Classes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Interfaces
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    _S3HttpAuthSchemeParametersAbortHandlerAbortSignalAbortSignalAddEventListenerOptionsAddOperationAddressInfoAgentOptionsAgentOptionsAnchorDataAPIGatewayEventClientCertificateAPIGatewayEventIdentityAPIGatewayEventRequestContextV2APIGatewayEventRequestContextWithAuthorizerAPIGatewayProxyEventBaseAPIGatewayProxyEventHeadersAPIGatewayProxyEventMultiValueHeadersAPIGatewayProxyEventMultiValueQueryStringParametersAPIGatewayProxyEventPathParametersAPIGatewayProxyEventQueryStringParametersAPIGatewayProxyEventStageVariablesAPIGatewayProxyEventV2WithRequestContextAppArrayBufferViewArrayIteratorArrayLikeAsyncGeneratorAsyncGeneratorFunctionAsyncIterableAsyncIterableIteratorAsyncIteratorAsyncResourceOptionsAuthSchemeAwsCredentialIdentityAwsRegionExtensionConfigurationAwsSdkSigV4AAuthInputConfigAwsSdkSigV4AuthInputConfigBaseMultipleResolvedValueMetadataInjectOptionsBaseOperationBaseOptionalResolvedValueMetadataInjectOptionsBaseParameterObjectBaseResolvedValueMetadataInjectOptionsBindInFluentSyntaxBindingConstraintsBindingIdentifierBindInWhenOnFluentSyntaxBindOnFluentSyntaxBindToFluentSyntaxBindWhenFluentSyntaxBindWhenOnFluentSyntaxBlobOptionsBlockMapBlockScalarBlockSequenceBodyLengthCalculatorBoundServiceSyntaxCallbackObjectCallbacksObjectCallSiteCertificateChecksumChecksumAlgorithmChecksumConfigurationChecksumConstructorClientContextClientContextClientClientContextEnvClientDefaultsClientInputEndpointParametersClientRequestArgsCognitoIdentityCollectionTagCommonConnectionOptionsComponentsObjectConnectionOptionsContactObjectContainerModuleLoadOptionsContainerOptionsContentObjectContextCookieOptionsCopyOperationCorsOptionsCreateNodeContextDecoderDefaultExtensionConfigurationDeserializeHandlerOutputDictDirectiveDiscriminatorObjectDisposableDocumentDocumentEndEncoderEncodingObjectEndpointEndpointInputConfigEndpointParametersEndpointV2ErrnoExceptionErrorHandlerErrorTokenEventEventEventEmitterEventEmitterOptionsEventInitEventListenerEventListenerObjectEventListenerOptionsEventStreamMarshallerEventStreamMarshallerDeserFnEventStreamMarshallerSerFnEventStreamSerdeInputConfigEventStreamSerdeProviderEventTargetEventTargetExampleObjectExamplesObjectExternalDocumentationObjectFetchHttpHandlerOptionsFileOptionsFinalizeHandlerFinalizeHandlerArgumentsFinalizeHandlerOutputFlexibleChecksumsInputConfigFloat16ArrayFloat16ArrayConstructorFlowCollectionFlowScalarGetAllOptionsGetAwsChunkedEncodingStreamGetAwsChunkedEncodingStreamOptionsGetOperationGetOptionsGetOptionsTagConstraintHashHashConstructorHeaderObjectHeadersHeadersObjectHostHeaderInputConfigHttpAuthExtensionConfigurationHttpAuthOptionHttpAuthSchemeHttpAuthSchemeInputConfigHttpAuthSchemeParametersHttpAuthSchemeProviderHttpHandlerExtensionConfigurationHttpHandlerOptionsHttpMessageHttpRequestHttpResponseHttpSignerIdentityIdentityProviderIdentityProviderConfigIncomingHttpHeadersInfoObjectInformationEventInitializeHandlerArgumentsInitializeHandlerOutputInt64IParameterExtractorIpcSocketConnectOptsIsBoundOptionsIterableIteratorIteratorReturnResultIteratorYieldResultKeyObjectLicenseObjectLinkObjectLinkParametersObjectLinksObjectLoggerLoggerOptionsLookupAddressLookupOptionsMediaTypeObjectMessageMetadataBearerMoveOperationMultipleOptionalResolvedValueMetadataInjectOptionsMultipleResolvedValueMetadataInjectOptionsNodeHttpHandlerOptionsOAuthFlowObjectOAuthFlowsObjectObjectOnReadOptsOpenAPIObjectOperationObjectOptionalGetOptionsOptionalResolvedValueMetadataInjectOptionsOptionsOutgoingHttpHeadersParameterObjectParsedParsedParsedParsedPathItemObjectPathsObjectPeerCertificatePromiseLikePropertyDescriptorProviderPSKCallbackNegotationPxfObjectQueuingStrategyQueuingStrategySizeReadableByteStreamControllerReadableByteStreamControllerCallbackReadableStreamReadableStreamReadableStreamAsyncIteratorReadableStreamBYOBReaderReadableStreamDefaultControllerReadableStreamDefaultReaderReadableStreamErrorCallbackReadableStreamGenericReaderReadableStreamGetReaderOptionsReadableStreamReadDoneResultReadableStreamReadValueResultReadableWritablePairReadOnlyDictReadWriteStreamReferenceObjectRegionInputConfigRegisterOptionsRemoveOperationReplaceOperationRequestBodyObjectRequestHandlerRequestHandlerMetadataRequestSignerRequestSigningArgumentsResolutionContextResolvedValueMetadataInjectTagOptionsResponseMetadataResponseObjectResponsesObjectRetryableTraitRetryErrorInfoRetryInputConfigRetryStrategyRetryStrategyConfigurationRetryStrategyV2RetryTokenRuntimeExtensionS3ClientConfigS3ExpressIdentityS3ExpressIdentityProviderS3ExtensionConfigurationS3HttpAuthSchemeParametersS3HttpAuthSchemeProviderS3InputConfigSamplingOptionsScalarTagSchemaObjectScopesObjectSdkStreamMixinSdkStreamMixinInjectorSecureContextSecureContextOptionsSecurityRequirementObjectSecuritySchemeObjectSerializeHandlerArgumentsServerObjectServerVariableObjectSignatureV4CryptoInitSignatureV4InitSigningArgumentsSmithyConfigurationSmithyExceptionSocketAddressInitOptionsSocketConstructorOptsSourceTokenSpecIterableSpecIterableIteratorSpecIteratorStaticEventEmitterIteratorOptionsStaticEventEmitterOptionsStreamCollectorStreamHasherStreamPipeOptionsSuccessHandlerTagBaseTagObjectTcpSocketConnectOptsTestOperationToJSContextUnderlyingByteSourceUnderlyingSinkUnderlyingSinkAbortCallbackUnderlyingSinkCloseCallbackUnderlyingSinkStartCallbackUnderlyingSinkWriteCallbackUnderlyingSourceUnderlyingSourceCancelCallbackUnderlyingSourcePullCallbackUnderlyingSourceStartCallbackURLUrlParserURLSearchParamsIteratorUserAgentInputConfigWritableStreamWritableStreamWritableStreamDefaultControllerWritableStreamDefaultWriterXmlObject
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Aliases
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    __Event__EventTarget_HeadersAbstractNewableAnyRestAPIGatewayEventDefaultAuthorizerContextAPIGatewayEventRequestContextAPIGatewayProxyEventAPIGatewayProxyEventV2ArgsArrayBufferLikeArrayBufferViewAutocompleteAutocompletePrimitiveBaseTypeAwsCredentialIdentityProviderBinaryHeaderValueBinaryLikeBindBindingActivationBindingDeactivationBindingScopeBooleanHeaderValueBufferEncodingBuiltinIteratorReturnBuiltinIteratorReturnByteHeaderValueChecksumConfigurationLegacyCollectionItemComposeFnParamCreateNodeOptionsDateInputDefaultEventMapDefaultsModeDocumentOptionsDynamicValueBuilderEndpointObjectPropertyEndpointParametersErrorCallbackErrorCodeErrorHandlingMiddlewareEventMapExcludeFactoryFinallyFunctionHandlerFunctionHeaderBagHeaderNamesHeaderRecordHeadersInitHeaderValueHttpHandlerHttpHandlerUserInputHttpRequestOptionsHttpResponseOptionsIANARegisteredMimeTypeIntegerHeaderValueIPVersionIsBoundISpecificationExtensionIteratorResultKeyKey2KnownHeaderValuesLinePosListenerLoggerFunctionLoggerFunctionAdditionalInfoLogLevelIdLongHeaderValueLookupFunctionLowercaseMapLikeMapToResolvedValueInjectOptionsMessageHeadersMessageHeaderValueMetadataNameMetadataTagMETHODSMiddlewareNewableNextFunctionNodeNodeTypeOmitOnActivationOnDeactivationOpenApiFormatOperationOutgoingHttpHeaderParameterLocationParameterSourceParameterStyleParsedNodeParseOptionsPartialPickPropertyKeyProviderQueryParameterBagRangeReadableStreamControllerReadableStreamReaderReadableStreamReadResultReadonlyRebindRebindSyncRecordReplacerRequestChecksumCalculationRequestHandlerOutputRequiredResolvedResolvedValueInjectOptionsResolvedValueMetadataInjectOptionsResponseChecksumValidationRetryErrorTypeReturnTypeReviverS3ClientConfigTypeSchemaObjectTypeSchemaOptionsSdkErrorSecureVersionSecuritySchemeTypeSerializerFunctionServiceIdentifierShortHeaderValueSocketConnectOptsSocketReadyStateSourceDataStringHeaderValueStringifyContextSyncResolvedTagIdTagsTimestampFunctionTimestampHeaderValueToJSOptionsTokenToStringOptionsTypeTypedArrayUnbindUnbindSyncURIUserAgentUserAgentPairUuidHeaderValue
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Variables
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Functions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    _construct_construct_destroy_destroy_final_write_writevaddaddaddaddInaddListeneraddListeneraddListeneraddListeneraddTrailersappendHeaderauthenticatebindclonecomposeconfigureApiconfigureAppconstructcreateAliascreateConnectioncreateNodecreatePairdeletedeletedeletedeleteIndestroydestroydestroyemitemitemitemitemitDestroyendendeventNameseveryextractAuthDatafilterfinalfindflatMapflushHeadersforEachgetgetgetgetHeadergetHeaderNamesgetHeadersgetIngetMaxListenershashashashasHeaderhasInhttpHandlerhttpHandlerConfigsinitialiseControllersinRequestScopeinSingletonScopeinTransientScopeiteratorlistenerCountlistenersmapnextnextnextoffonononononActivationonceonceonceonceonDeactivationpausepausepipepipeprependListenerprependListenerprependListenerprependListenerprependOnceListenerprependOnceListenerprependOnceListenerprependOnceListenerrawListenersreadreadreduceremoveAllListenersremoveHeaderremoveListenerremoveListenerremoveListenerremoveListenerresolveresumeresumereturnreturnrunInAsyncScopesetsetsetsetDefaultEncodingsetEncodingsetEncodingsetHeadersetHeaderssetHttpHandlersetInsetMaxListenerssetSchemasetTimeoutsomethrowthrowtoJStoJSONtoJSONtoJSONtoJSONtoStringtoStringtoStringtoStringtoStringtoStringunpipeunpipeunshiftupdateHttpClientConfigwhenwhenAnyAncestorwhenAnyAncestorIswhenAnyAncestorNamedwhenAnyAncestorTaggedwhenDefaultwhenNamedwhenNoAncestorwhenNoAncestorIswhenNoAncestorNamedwhenNoAncestorTaggedwhenNoParentwhenNoParentIswhenNoParentNamedwhenNoParentTaggedwhenParentwhenParentIswhenParentNamedwhenParentTaggedwhenTaggedwrapwrapwritewritewritewritev
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    References
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +<internal> | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Module <internal>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Namespaces

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Alias
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Document
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      EventEmitter
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Scalar
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Stream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      YAMLMap
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      YAMLSeq

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Enumerations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      AlgorithmId

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Classes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Agent
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Agent
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Alias
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      API
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ApiBody
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ApiBodyInfo
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ApiOperation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ApiOperationInfo
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ApiParam
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      AsyncResource
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      AuthFilterInfo
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Blob
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      BlockList
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ClientRequest
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Collection
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Container
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ContainerModule
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ControllerInfo
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Directives
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Document
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      EndpointInfo
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      EventEmitter
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Headers
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      HttpRequest
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      HttpResponse
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      IncomingMessage
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      LazyServiceIdentifier
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      LineCounter
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      NodeBase
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      OpenApiBuilder
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      OpenApiGenerator
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      OutgoingMessage
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Pair
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Readable
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Request
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Response
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Scalar
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Schema
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Socket
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      SocketAddress
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Stream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      URL
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      URLSearchParams
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      YAMLError
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      YAMLMap
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      YAMLSeq
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      YAMLWarning

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Interfaces

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      _S3HttpAuthSchemeParameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      AbortHandler
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      AbortSignal
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      AbortSignal
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      AbortSignal
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      AddEventListenerOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      AddOperation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      AddressInfo
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      AgentOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      AgentOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      AnchorData
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      APIGatewayEventClientCertificate
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      APIGatewayEventIdentity
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      APIGatewayEventRequestContextV2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      APIGatewayEventRequestContextWithAuthorizer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      APIGatewayProxyEventBase
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      APIGatewayProxyEventHeaders
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      APIGatewayProxyEventMultiValueHeaders
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      APIGatewayProxyEventMultiValueQueryStringParameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      APIGatewayProxyEventPathParameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      APIGatewayProxyEventQueryStringParameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      APIGatewayProxyEventStageVariables
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      APIGatewayProxyEventV2WithRequestContext
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      App
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ArrayBufferView
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ArrayIterator
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ArrayLike
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      AsyncGenerator
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      AsyncGeneratorFunction
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      AsyncIterable
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      AsyncIterableIterator
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      AsyncIterator
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      AsyncResourceOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      AuthScheme
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      AwsCredentialIdentity
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      AwsRegionExtensionConfiguration
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      AwsSdkSigV4AAuthInputConfig
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      AwsSdkSigV4AuthInputConfig
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      BaseMultipleResolvedValueMetadataInjectOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      BaseOperation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      BaseOptionalResolvedValueMetadataInjectOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      BaseParameterObject
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      BaseResolvedValueMetadataInjectOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      BindInFluentSyntax
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      BindingConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      BindingIdentifier
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      BindInWhenOnFluentSyntax
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      BindOnFluentSyntax
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      BindToFluentSyntax
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      BindWhenFluentSyntax
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      BindWhenOnFluentSyntax
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      BlobOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      BlockMap
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      BlockScalar
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      BlockSequence
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      BodyLengthCalculator
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      BoundServiceSyntax
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      CallbackObject
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      CallbacksObject
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      CallSite
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Certificate
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Checksum
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ChecksumAlgorithm
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ChecksumConfiguration
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ChecksumConstructor
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ClientContext
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ClientContextClient
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ClientContextEnv
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ClientDefaults
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ClientInputEndpointParameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ClientProtocol
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ClientRequestArgs
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Codec
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      CognitoIdentity
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      CollectionTag
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      CommonConnectionOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ComponentsObject
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ConfigurableSerdeContext
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ConnectionOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ContactObject
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ContainerModuleLoadOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ContainerOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ContentObject
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Context
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      CookieOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      CopyOperation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      CorsOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      CreateNodeContext
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Decoder
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      DefaultExtensionConfiguration
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      DeserializeHandlerOutput
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      DetailedPeerCertificate
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Dict
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Directive
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      DiscriminatorObject
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Disposable
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Document
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      DocumentEnd
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Encoder
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      EncodingObject
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Endpoint
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      EndpointBearer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      EndpointInputConfig
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      EndpointParameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      EndpointV2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ErrnoException
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ErrorHandler
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ErrorToken
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Event
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Event
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      EventEmitter
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      EventEmitterOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      EventInit
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      EventListener
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      EventListenerObject
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      EventListenerOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      EventListenerOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      EventStreamMarshaller
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      EventStreamMarshallerDeserFn
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      EventStreamMarshallerSerFn
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      EventStreamSerdeInputConfig
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      EventStreamSerdeProvider
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      EventTarget
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      EventTarget
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ExampleObject
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ExamplesObject
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ExternalDocumentationObject
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      FetchHttpHandlerOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      FileOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      FinalizeHandler
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      FinalizeHandlerArguments
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      FinalizeHandlerOutput
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      FlexibleChecksumsInputConfig
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Float16Array
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Float16ArrayConstructor
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      FlowCollection
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      FlowScalar
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Generator
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      GetAllOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      GetAwsChunkedEncodingStream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      GetAwsChunkedEncodingStreamOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      GetOperation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      GetOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      GetOptionsTagConstraint
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Hash
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      HashConstructor
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      HeaderObject
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Headers
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      HeadersObject
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      HostHeaderInputConfig
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      HttpAuthExtensionConfiguration
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      HttpAuthOption
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      HttpAuthScheme
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      HttpAuthSchemeInputConfig
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      HttpAuthSchemeParameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      HttpAuthSchemeProvider
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      HttpHandlerExtensionConfiguration
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      HttpHandlerOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      HttpMessage
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      HttpRequest
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      HttpResponse
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      HttpSigner
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Identity
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      IdentityProvider
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      IdentityProviderConfig
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      IncomingHttpHeaders
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      InfoObject
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      InformationEvent
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      InitializeHandlerArguments
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      InitializeHandlerOutput
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Int64
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      IParameterExtractor
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      IpcSocketConnectOpts
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      IsBoundOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Iterable
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Iterator
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      IteratorReturnResult
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      IteratorYieldResult
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      KeyObject
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      LicenseObject
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      LinkObject
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      LinkParametersObject
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      LinksObject
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ListSchema
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Logger
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      LoggerOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      LookupAddress
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      LookupOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      MapSchema
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      MediaTypeObject
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Message
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      MetadataBearer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      MoveOperation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      MultipleOptionalResolvedValueMetadataInjectOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      MultipleResolvedValueMetadataInjectOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      NodeHttpHandlerOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      NormalizedSchema
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      OAuthFlowObject
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      OAuthFlowsObject
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      OnReadOpts
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      OpenAPIObject
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      OperationObject
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      OperationSchema
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      OptionalGetOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      OptionalResolvedValueMetadataInjectOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Options
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      OutgoingHttpHeaders
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ParameterObject
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Parsed
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Parsed
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Parsed
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Parsed
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      PathItemObject
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      PathsObject
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      PeerCertificate
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ProcessEnv
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      PromiseLike
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      PropertyDescriptor
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Provider
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ProxyEnv
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      PSKCallbackNegotation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      PxfObject
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      QueuingStrategy
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      QueuingStrategySize
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ReadableByteStreamController
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ReadableByteStreamControllerCallback
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ReadableStream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ReadableStream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ReadableStreamAsyncIterator
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ReadableStreamBYOBReader
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ReadableStreamDefaultController
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ReadableStreamDefaultReader
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ReadableStreamErrorCallback
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ReadableStreamGenericReader
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ReadableStreamGetReaderOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ReadableStreamReadDoneResult
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ReadableStreamReadValueResult
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ReadableWritablePair
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ReadOnlyDict
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ReadWriteStream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ReferenceObject
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      RegionInputConfig
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      RegisterOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      RemoveOperation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ReplaceOperation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      RequestBodyObject
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      RequestHandler
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      RequestHandlerMetadata
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      RequestOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      RequestOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      RequestSigner
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      RequestSigningArguments
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ResolutionContext
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ResolvedValueMetadataInjectTagOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ResponseMetadata
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ResponseObject
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ResponsesObject
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      RetryableTrait
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      RetryErrorInfo
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      RetryInputConfig
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      RetryStrategy
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      RetryStrategyConfiguration
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      RetryStrategyV2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      RetryToken
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      RuntimeExtension
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      S3ClientConfig
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      S3ExpressIdentity
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      S3ExpressIdentityProvider
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      S3ExtensionConfiguration
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      S3HttpAuthSchemeParameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      S3HttpAuthSchemeProvider
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      S3InputConfig
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      SamplingOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ScalarTag
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      SchemaObject
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ScopesObject
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      SdkStreamMixin
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      SdkStreamMixinInjector
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      SecureContext
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      SecureContextOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      SecurityRequirementObject
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      SecuritySchemeObject
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      SerdeFunctions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      SerializeHandlerArguments
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ServerObject
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ServerVariableObject
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ShapeDeserializer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ShapeSerializer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      SignatureV4CryptoInit
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      SignatureV4Init
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      SigningArguments
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      SmithyConfiguration
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      SmithyException
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      SocketAddressInitOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      SocketConstructorOpts
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      SourceToken
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      SpecIterable
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      SpecIterableIterator
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      SpecIterator
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      StaticEventEmitterIteratorOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      StaticEventEmitterOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      StreamCollector
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      StreamHasher
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      StreamPipeOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      StructureSchema
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      SuccessHandler
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      TagBase
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      TagObject
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      TcpSocketConnectOpts
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      TestOperation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ToJSContext
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      TraitsSchema
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      UnderlyingByteSource
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      UnderlyingSink
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      UnderlyingSinkAbortCallback
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      UnderlyingSinkCloseCallback
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      UnderlyingSinkStartCallback
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      UnderlyingSinkWriteCallback
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      UnderlyingSource
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      UnderlyingSourceCancelCallback
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      UnderlyingSourcePullCallback
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      UnderlyingSourceStartCallback
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      URL
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      UrlParser
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      URLSearchParamsIterator
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      UserAgentInputConfig
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      WritableStream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      WritableStream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      WritableStreamDefaultController
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      WritableStreamDefaultWriter
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      XmlObject

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Aliases

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      _AbortSignal
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      _Event
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      _EventListenerOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      _EventTarget
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      _Headers
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      $MemberSchema
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      $Schema
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      $SchemaRef
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      AbstractNewable
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      AnyRest
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      APIGatewayEventDefaultAuthorizerContext
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      APIGatewayEventRequestContext
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      APIGatewayProxyEvent
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      APIGatewayProxyEventV2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Args
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ArrayBufferLike
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ArrayBufferView
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Autocomplete
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      AutocompletePrimitiveBaseType
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      AwsCredentialIdentityProvider
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      BigDecimalSchema
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      BigIntegerSchema
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      BinaryHeaderValue
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      BinaryLike
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Bind
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      BindingActivation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      BindingDeactivation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      BindingScope
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      BlobSchema
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      BlobSchemas
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      BooleanHeaderValue
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      BooleanSchema
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      BufferEncoding
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      BuiltinIteratorReturn
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      BuiltinIteratorReturn
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ByteHeaderValue
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ChecksumConfigurationLegacy
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      CollectionItem
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ComposeFnParam
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      CreateNodeOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      DateInput
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      DefaultEventMap
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      DefaultsMode
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      DocumentOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      DocumentSchema
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      DynamicValueBuilder
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      EndpointObjectProperty
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      EndpointParameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ErrorCallback
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ErrorCode
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ErrorHandlingMiddleware
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      EventMap
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Exclude
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Factory
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      FinallyFunction
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      HandlerFunction
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      HeaderBag
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      HeaderNames
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      HeaderRecord
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      HeadersInit
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      HeaderValue
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      HttpHandler
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      HttpHandlerUserInput
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      HttpLabelBitMask
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      HttpPayloadBitMask
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      HttpQueryParamsBitMask
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      HttpRequestOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      HttpResponseCodeBitMask
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      HttpResponseOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      IANARegisteredMimeType
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      IdempotencyTokenBitMask
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      IdempotentBitMask
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      IntegerHeaderValue
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      IPVersion
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      IsBound
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ISpecificationExtension
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      IteratorResult
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Key
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Key2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      KnownHeaderValues
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      LinePos
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Listener
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      LoggerFunction
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      LoggerFunctionAdditionalInfo
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      LogLevelId
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      LongHeaderValue
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      LookupFunction
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Lowercase
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      MapLike
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      MapToResolvedValueInjectOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      MemberSchema
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      MessageHeaders
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      MessageHeaderValue
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      MetadataName
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      MetadataTag
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      METHODS
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Middleware
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Newable
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      NextFunction
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Node
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      NodeType
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      NonSharedBuffer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      NumericSchema
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Omit
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      OnActivation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      OnDeactivation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      OpenApiFormat
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Operation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      OutgoingHttpHeader
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ParameterLocation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ParameterSource
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ParameterStyle
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ParsedNode
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ParseOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Partial
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      PartialOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Pick
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      PropertyKey
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Provider
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      QueryParameterBag
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Range
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ReadableStreamController
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ReadableStreamReader
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ReadableStreamReadResult
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Readonly
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Rebind
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      RebindSync
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Record
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Replacer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      RequestChecksumCalculation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      RequestHandlerOutput
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Required
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Resolved
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ResolvedValueInjectOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ResolvedValueMetadataInjectOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ResponseChecksumValidation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      RetryErrorType
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ReturnType
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Reviver
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      S3ClientConfigType
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Schema
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      SchemaObjectType
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      SchemaOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      SchemaRef
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      SchemaTraits
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      SchemaTraitsObject
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      SdkError
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      SecureVersion
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      SecuritySchemeType
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      SensitiveBitMask
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      SerializerFunction
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ServiceIdentifier
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ShapeName
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ShapeNamespace
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ShortHeaderValue
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      SimpleSchema
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      SocketConnectOpts
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      SocketReadyState
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      SourceData
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      StaticErrorSchema
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      StaticListSchema
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      StaticMapSchema
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      StaticOperationSchema
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      StaticSchema
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      StaticSchemaIdError
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      StaticSchemaIdList
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      StaticSchemaIdMap
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      StaticSchemaIdOperation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      StaticSchemaIdSimple
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      StaticSchemaIdStruct
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      StaticSimpleSchema
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      StaticStructureSchema
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      StreamingBlobSchema
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      StringHeaderValue
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      StringifyContext
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      StringSchema
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      SyncResolved
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      TagId
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Tags
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      TimestampDateTimeSchema
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      TimestampDefaultSchema
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      TimestampEpochSecondsSchema
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      TimestampFunction
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      TimestampHeaderValue
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      TimestampHttpDateSchema
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      TimestampSchemas
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ToJSOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Token
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ToStringOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      TraitBitVector
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      TypedArray
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Unbind
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      UnbindSync
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      UnitSchema
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      URI
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      UserAgent
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      UserAgentPair
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      UuidHeaderValue

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      AbortSignal
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Event
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      EventTarget
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Float16Array
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Headers
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ReadableByteStreamController
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ReadableStream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ReadableStreamBYOBReader
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ReadableStreamDefaultController
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ReadableStreamDefaultReader
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      RequestChecksumCalculation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ResponseChecksumValidation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      tagsByName
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      URL
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      WritableStream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      WritableStreamDefaultController
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      WritableStreamDefaultWriter

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      References

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Abortable → EventEmitter.Abortable
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ArrayOptions → Stream.ArrayOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ReadableOptions → Stream.ReadableOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Namespaces
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Enumerations
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Classes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Interfaces
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      _S3HttpAuthSchemeParametersAbortHandlerAbortSignalAbortSignalAbortSignalAddEventListenerOptionsAddOperationAddressInfoAgentOptionsAgentOptionsAnchorDataAPIGatewayEventClientCertificateAPIGatewayEventIdentityAPIGatewayEventRequestContextV2APIGatewayEventRequestContextWithAuthorizerAPIGatewayProxyEventBaseAPIGatewayProxyEventHeadersAPIGatewayProxyEventMultiValueHeadersAPIGatewayProxyEventMultiValueQueryStringParametersAPIGatewayProxyEventPathParametersAPIGatewayProxyEventQueryStringParametersAPIGatewayProxyEventStageVariablesAPIGatewayProxyEventV2WithRequestContextAppArrayBufferViewArrayIteratorArrayLikeAsyncGeneratorAsyncGeneratorFunctionAsyncIterableAsyncIterableIteratorAsyncIteratorAsyncResourceOptionsAuthSchemeAwsCredentialIdentityAwsRegionExtensionConfigurationAwsSdkSigV4AAuthInputConfigAwsSdkSigV4AuthInputConfigBaseMultipleResolvedValueMetadataInjectOptionsBaseOperationBaseOptionalResolvedValueMetadataInjectOptionsBaseParameterObjectBaseResolvedValueMetadataInjectOptionsBindInFluentSyntaxBindingConstraintsBindingIdentifierBindInWhenOnFluentSyntaxBindOnFluentSyntaxBindToFluentSyntaxBindWhenFluentSyntaxBindWhenOnFluentSyntaxBlobOptionsBlockMapBlockScalarBlockSequenceBodyLengthCalculatorBoundServiceSyntaxCallbackObjectCallbacksObjectCallSiteCertificateChecksumChecksumAlgorithmChecksumConfigurationChecksumConstructorClientContextClientContextClientClientContextEnvClientDefaultsClientInputEndpointParametersClientProtocolClientRequestArgsCodecCognitoIdentityCollectionTagCommonConnectionOptionsComponentsObjectConfigurableSerdeContextConnectionOptionsContactObjectContainerModuleLoadOptionsContainerOptionsContentObjectContextCookieOptionsCopyOperationCorsOptionsCreateNodeContextDecoderDefaultExtensionConfigurationDeserializeHandlerOutputDetailedPeerCertificateDictDirectiveDiscriminatorObjectDisposableDocumentDocumentEndEncoderEncodingObjectEndpointEndpointBearerEndpointInputConfigEndpointParametersEndpointV2ErrnoExceptionErrorHandlerErrorTokenEventEventEventEmitterEventEmitterOptionsEventInitEventListenerEventListenerObjectEventListenerOptionsEventListenerOptionsEventStreamMarshallerEventStreamMarshallerDeserFnEventStreamMarshallerSerFnEventStreamSerdeInputConfigEventStreamSerdeProviderEventTargetEventTargetExampleObjectExamplesObjectExternalDocumentationObjectFetchHttpHandlerOptionsFileOptionsFinalizeHandlerFinalizeHandlerArgumentsFinalizeHandlerOutputFlexibleChecksumsInputConfigFloat16ArrayFloat16ArrayConstructorFlowCollectionFlowScalarGeneratorGetAllOptionsGetAwsChunkedEncodingStreamGetAwsChunkedEncodingStreamOptionsGetOperationGetOptionsGetOptionsTagConstraintHashHashConstructorHeaderObjectHeadersHeadersObjectHostHeaderInputConfigHttpAuthExtensionConfigurationHttpAuthOptionHttpAuthSchemeHttpAuthSchemeInputConfigHttpAuthSchemeParametersHttpAuthSchemeProviderHttpHandlerExtensionConfigurationHttpHandlerOptionsHttpMessageHttpRequestHttpResponseHttpSignerIdentityIdentityProviderIdentityProviderConfigIncomingHttpHeadersInfoObjectInformationEventInitializeHandlerArgumentsInitializeHandlerOutputInt64IParameterExtractorIpcSocketConnectOptsIsBoundOptionsIterableIteratorIteratorReturnResultIteratorYieldResultKeyObjectLicenseObjectLinkObjectLinkParametersObjectLinksObjectListSchemaLoggerLoggerOptionsLookupAddressLookupOptionsMapSchemaMediaTypeObjectMessageMetadataBearerMoveOperationMultipleOptionalResolvedValueMetadataInjectOptionsMultipleResolvedValueMetadataInjectOptionsNodeHttpHandlerOptionsNormalizedSchemaOAuthFlowObjectOAuthFlowsObjectObjectOnReadOptsOpenAPIObjectOperationObjectOperationSchemaOptionalGetOptionsOptionalResolvedValueMetadataInjectOptionsOptionsOutgoingHttpHeadersParameterObjectParsedParsedParsedParsedPathItemObjectPathsObjectPeerCertificateProcessEnvPromiseLikePropertyDescriptorProviderProxyEnvPSKCallbackNegotationPxfObjectQueuingStrategyQueuingStrategySizeReadableByteStreamControllerReadableByteStreamControllerCallbackReadableStreamReadableStreamReadableStreamAsyncIteratorReadableStreamBYOBReaderReadableStreamDefaultControllerReadableStreamDefaultReaderReadableStreamErrorCallbackReadableStreamGenericReaderReadableStreamGetReaderOptionsReadableStreamReadDoneResultReadableStreamReadValueResultReadableWritablePairReadOnlyDictReadWriteStreamReferenceObjectRegionInputConfigRegisterOptionsRemoveOperationReplaceOperationRequestBodyObjectRequestHandlerRequestHandlerMetadataRequestOptionsRequestOptionsRequestSignerRequestSigningArgumentsResolutionContextResolvedValueMetadataInjectTagOptionsResponseMetadataResponseObjectResponsesObjectRetryableTraitRetryErrorInfoRetryInputConfigRetryStrategyRetryStrategyConfigurationRetryStrategyV2RetryTokenRuntimeExtensionS3ClientConfigS3ExpressIdentityS3ExpressIdentityProviderS3ExtensionConfigurationS3HttpAuthSchemeParametersS3HttpAuthSchemeProviderS3InputConfigSamplingOptionsScalarTagSchemaObjectScopesObjectSdkStreamMixinSdkStreamMixinInjectorSecureContextSecureContextOptionsSecurityRequirementObjectSecuritySchemeObjectSerdeFunctionsSerializeHandlerArgumentsServerObjectServerVariableObjectShapeDeserializerShapeSerializerSignatureV4CryptoInitSignatureV4InitSigningArgumentsSmithyConfigurationSmithyExceptionSocketAddressInitOptionsSocketConstructorOptsSourceTokenSpecIterableSpecIterableIteratorSpecIteratorStaticEventEmitterIteratorOptionsStaticEventEmitterOptionsStreamCollectorStreamHasherStreamPipeOptionsStructureSchemaSuccessHandlerTagBaseTagObjectTcpSocketConnectOptsTestOperationToJSContextTraitsSchemaUnderlyingByteSourceUnderlyingSinkUnderlyingSinkAbortCallbackUnderlyingSinkCloseCallbackUnderlyingSinkStartCallbackUnderlyingSinkWriteCallbackUnderlyingSourceUnderlyingSourceCancelCallbackUnderlyingSourcePullCallbackUnderlyingSourceStartCallbackURLUrlParserURLSearchParamsIteratorUserAgentInputConfigWritableStreamWritableStreamWritableStreamDefaultControllerWritableStreamDefaultWriterXmlObject
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Aliases
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      _AbortSignal_Event_EventListenerOptions_EventTarget_Headers$MemberSchema$Schema$SchemaRefAbstractNewableAnyRestAPIGatewayEventDefaultAuthorizerContextAPIGatewayEventRequestContextAPIGatewayProxyEventAPIGatewayProxyEventV2ArgsArrayBufferLikeArrayBufferViewAutocompleteAutocompletePrimitiveBaseTypeAwsCredentialIdentityProviderBigDecimalSchemaBigIntegerSchemaBinaryHeaderValueBinaryLikeBindBindingActivationBindingDeactivationBindingScopeBlobSchemaBlobSchemasBooleanHeaderValueBooleanSchemaBufferEncodingBuiltinIteratorReturnBuiltinIteratorReturnByteHeaderValueChecksumConfigurationLegacyCollectionItemComposeFnParamCreateNodeOptionsDateInputDefaultEventMapDefaultsModeDocumentOptionsDocumentSchemaDynamicValueBuilderEndpointObjectPropertyEndpointParametersErrorCallbackErrorCodeErrorHandlingMiddlewareEventMapExcludeFactoryFinallyFunctionHandlerFunctionHeaderBagHeaderNamesHeaderRecordHeadersInitHeaderValueHttpHandlerHttpHandlerUserInputHttpLabelBitMaskHttpPayloadBitMaskHttpQueryParamsBitMaskHttpRequestOptionsHttpResponseCodeBitMaskHttpResponseOptionsIANARegisteredMimeTypeIdempotencyTokenBitMaskIdempotentBitMaskIntegerHeaderValueIPVersionIsBoundISpecificationExtensionIteratorResultKeyKey2KnownHeaderValuesLinePosListenerLoggerFunctionLoggerFunctionAdditionalInfoLogLevelIdLongHeaderValueLookupFunctionLowercaseMapLikeMapToResolvedValueInjectOptionsMemberSchemaMessageHeadersMessageHeaderValueMetadataNameMetadataTagMETHODSMiddlewareNewableNextFunctionNodeNodeTypeNonSharedBufferNumericSchemaOmitOnActivationOnDeactivationOpenApiFormatOperationOutgoingHttpHeaderParameterLocationParameterSourceParameterStyleParsedNodeParseOptionsPartialPartialOptionsPickPropertyKeyProviderQueryParameterBagRangeReadableStreamControllerReadableStreamReaderReadableStreamReadResultReadonlyRebindRebindSyncRecordReplacerRequestChecksumCalculationRequestHandlerOutputRequiredResolvedResolvedValueInjectOptionsResolvedValueMetadataInjectOptionsResponseChecksumValidationRetryErrorTypeReturnTypeReviverS3ClientConfigTypeSchemaSchemaObjectTypeSchemaOptionsSchemaRefSchemaTraitsSchemaTraitsObjectSdkErrorSecureVersionSecuritySchemeTypeSensitiveBitMaskSerializerFunctionServiceIdentifierShapeNameShapeNamespaceShortHeaderValueSimpleSchemaSocketConnectOptsSocketReadyStateSourceDataStaticErrorSchemaStaticListSchemaStaticMapSchemaStaticOperationSchemaStaticSchemaStaticSchemaIdErrorStaticSchemaIdListStaticSchemaIdMapStaticSchemaIdOperationStaticSchemaIdSimpleStaticSchemaIdStructStaticSimpleSchemaStaticStructureSchemaStreamingBlobSchemaStringHeaderValueStringifyContextStringSchemaSyncResolvedTagIdTagsTimestampDateTimeSchemaTimestampDefaultSchemaTimestampEpochSecondsSchemaTimestampFunctionTimestampHeaderValueTimestampHttpDateSchemaTimestampSchemasToJSOptionsTokenToStringOptionsTraitBitVectorTypeTypedArrayUnbindUnbindSyncUnitSchemaURIUserAgentUserAgentPairUuidHeaderValue
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Variables
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      References
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/types/JsonPatch.html b/docs/types/JsonPatch.html index de9de079..de2423ac 100644 --- a/docs/types/JsonPatch.html +++ b/docs/types/JsonPatch.html @@ -1,2 +1,2 @@ JsonPatch | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias JsonPatch

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        JsonPatch: Operation[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        A collection of JSON patch operations, defined by the Operation class.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/types/_internal_.APIGatewayProxyEventV2.html b/docs/types/_internal_.APIGatewayProxyEventV2.html index 0084483d..96ca8707 100644 --- a/docs/types/_internal_.APIGatewayProxyEventV2.html +++ b/docs/types/_internal_.APIGatewayProxyEventV2.html @@ -1,2 +1,2 @@ APIGatewayProxyEventV2 | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Alias APIGatewayProxyEventV2

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          APIGatewayProxyEventV2: APIGatewayProxyEventV2WithRequestContext<
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              APIGatewayEventRequestContextV2,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          >

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Default Proxy event with no Authorizer

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/types/_internal_.AnyRest.html b/docs/types/_internal_.AnyRest.html index f309ccdf..d3f08113 100644 --- a/docs/types/_internal_.AnyRest.html +++ b/docs/types/_internal_.AnyRest.html @@ -1 +1 @@ -AnyRest | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias AnyRest

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            AnyRest: [args: any[]]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +AnyRest | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Alias AnyRest

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              AnyRest: [args: any[]]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/types/_internal_.Args.html b/docs/types/_internal_.Args.html index 503712fe..4d441eac 100644 --- a/docs/types/_internal_.Args.html +++ b/docs/types/_internal_.Args.html @@ -1 +1 @@ -Args | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Alias Args<K, T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Args: T extends DefaultEventMap ? AnyRest : K extends keyof T ? T[K] : never

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • K
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +Args | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Alias Args<K, T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Args: T extends DefaultEventMap ? AnyRest : K extends keyof T ? T[K] : never

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • K
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/types/_internal_.AwsCredentialIdentityProvider.html b/docs/types/_internal_.AwsCredentialIdentityProvider.html index b3327742..44673c51 100644 --- a/docs/types/_internal_.AwsCredentialIdentityProvider.html +++ b/docs/types/_internal_.AwsCredentialIdentityProvider.html @@ -1 +1 @@ -AwsCredentialIdentityProvider | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Alias AwsCredentialIdentityProvider

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    AwsCredentialIdentityProvider: IdentityProvider<AwsCredentialIdentity>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +AwsCredentialIdentityProvider | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Alias AwsCredentialIdentityProvider

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      AwsCredentialIdentityProvider: IdentityProvider<AwsCredentialIdentity>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/types/_internal_.BigDecimalSchema.html b/docs/types/_internal_.BigDecimalSchema.html new file mode 100644 index 00000000..6266e6f4 --- /dev/null +++ b/docs/types/_internal_.BigDecimalSchema.html @@ -0,0 +1 @@ +BigDecimalSchema | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias BigDecimalSchema

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        BigDecimalSchema: 19

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/types/_internal_.BigIntegerSchema.html b/docs/types/_internal_.BigIntegerSchema.html new file mode 100644 index 00000000..3844b69c --- /dev/null +++ b/docs/types/_internal_.BigIntegerSchema.html @@ -0,0 +1 @@ +BigIntegerSchema | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Alias BigIntegerSchema

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          BigIntegerSchema: 17

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/types/_internal_.BinaryHeaderValue.html b/docs/types/_internal_.BinaryHeaderValue.html index a81f24f8..15dcc256 100644 --- a/docs/types/_internal_.BinaryHeaderValue.html +++ b/docs/types/_internal_.BinaryHeaderValue.html @@ -1 +1 @@ -BinaryHeaderValue | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias BinaryHeaderValue

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            BinaryHeaderValue: HeaderValue<"binary", Uint8Array>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +BinaryHeaderValue | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Alias BinaryHeaderValue

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              BinaryHeaderValue: HeaderValue<"binary", Uint8Array>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/types/_internal_.BinaryLike.html b/docs/types/_internal_.BinaryLike.html index dca758f7..7280c30f 100644 --- a/docs/types/_internal_.BinaryLike.html +++ b/docs/types/_internal_.BinaryLike.html @@ -1 +1 @@ -BinaryLike | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Alias BinaryLike

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                BinaryLike: string | ArrayBufferView

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +BinaryLike | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Alias BinaryLike

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  BinaryLike: string | ArrayBufferView

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/types/_internal_.Bind.html b/docs/types/_internal_.Bind.html index d5c902bb..4f03d9c7 100644 --- a/docs/types/_internal_.Bind.html +++ b/docs/types/_internal_.Bind.html @@ -1 +1 @@ -Bind | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Alias Bind

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Bind: <T>(serviceIdentifier: ServiceIdentifier<T>) => BindToFluentSyntax<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +Bind | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Alias Bind

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Bind: <T>(serviceIdentifier: ServiceIdentifier<T>) => BindToFluentSyntax<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/types/_internal_.BindingActivation.html b/docs/types/_internal_.BindingActivation.html index 20827df6..726bd3f8 100644 --- a/docs/types/_internal_.BindingActivation.html +++ b/docs/types/_internal_.BindingActivation.html @@ -1 +1 @@ -BindingActivation | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias BindingActivation<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        BindingActivation: (context: ResolutionContext, injectable: T) => Resolved<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • T = unknown

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +BindingActivation | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Alias BindingActivation<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          BindingActivation: (context: ResolutionContext, injectable: T) => Resolved<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • T = unknown

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/types/_internal_.BindingDeactivation.html b/docs/types/_internal_.BindingDeactivation.html index fc5f6074..cad0c36b 100644 --- a/docs/types/_internal_.BindingDeactivation.html +++ b/docs/types/_internal_.BindingDeactivation.html @@ -1 +1 @@ -BindingDeactivation | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias BindingDeactivation<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            BindingDeactivation: (injectable: T) => void | Promise<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • T = unknown

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • (injectable: T): void | Promise<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • injectable: T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns void | Promise<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +BindingDeactivation | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Alias BindingDeactivation<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              BindingDeactivation: (injectable: T) => void | Promise<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • T = unknown

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • (injectable: T): void | Promise<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • injectable: T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns void | Promise<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/types/_internal_.BlobSchema.html b/docs/types/_internal_.BlobSchema.html new file mode 100644 index 00000000..00f51c29 --- /dev/null +++ b/docs/types/_internal_.BlobSchema.html @@ -0,0 +1,3 @@ +BlobSchema | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Alias BlobSchema

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                BlobSchema: 21

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                The blob Smithy type, in JS as Uint8Array and other representations +such as Buffer, string, or Readable(Stream) depending on circumstances.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Alias BlobSchemas

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  BlobSchemas: BlobSchema | StreamingBlobSchema

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Sentinel values for Blob schema.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/types/_internal_.BooleanHeaderValue.html b/docs/types/_internal_.BooleanHeaderValue.html index 54eda655..41d1c9bd 100644 --- a/docs/types/_internal_.BooleanHeaderValue.html +++ b/docs/types/_internal_.BooleanHeaderValue.html @@ -1 +1 @@ -BooleanHeaderValue | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Alias BooleanHeaderValue

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    BooleanHeaderValue: HeaderValue<"boolean", boolean>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +BooleanHeaderValue | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Alias BooleanHeaderValue

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      BooleanHeaderValue: HeaderValue<"boolean", boolean>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias BooleanSchema

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        BooleanSchema: 2

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/types/_internal_.BufferEncoding.html b/docs/types/_internal_.BufferEncoding.html index afbb13db..27745820 100644 --- a/docs/types/_internal_.BufferEncoding.html +++ b/docs/types/_internal_.BufferEncoding.html @@ -1 +1 @@ -BufferEncoding | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Alias BufferEncoding

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          BufferEncoding:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | "ascii"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | "utf8"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | "utf-8"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | "utf16le"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | "utf-16le"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | "ucs2"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | "ucs-2"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | "base64"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | "base64url"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | "latin1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | "binary"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | "hex"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +BufferEncoding | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias BufferEncoding

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            BufferEncoding:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | "ascii"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | "utf8"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | "utf-8"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | "utf16le"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | "utf-16le"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | "ucs2"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | "ucs-2"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | "base64"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | "base64url"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | "latin1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | "binary"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | "hex"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/types/_internal_.BuiltinIteratorReturn-1.html b/docs/types/_internal_.BuiltinIteratorReturn-1.html index 0ac04dc3..1e3e4aab 100644 --- a/docs/types/_internal_.BuiltinIteratorReturn-1.html +++ b/docs/types/_internal_.BuiltinIteratorReturn-1.html @@ -1,3 +1,3 @@ BuiltinIteratorReturn | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Alias BuiltinIteratorReturn

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              BuiltinIteratorReturn: intrinsic

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Defines the TReturn type used for built-in iterators produced by Array, Map, Set, and others. This is undefined when strictBuiltInIteratorReturn is true; otherwise, this is any.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/types/_internal_.ByteHeaderValue.html b/docs/types/_internal_.ByteHeaderValue.html index e200b1dd..954c4716 100644 --- a/docs/types/_internal_.ByteHeaderValue.html +++ b/docs/types/_internal_.ByteHeaderValue.html @@ -1 +1 @@ -ByteHeaderValue | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Alias ByteHeaderValue

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ByteHeaderValue: HeaderValue<"byte", number>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +ByteHeaderValue | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Alias ByteHeaderValue

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ByteHeaderValue: HeaderValue<"byte", number>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/types/_internal_.ComposeFnParam.html b/docs/types/_internal_.ComposeFnParam.html index ace64501..7d77957a 100644 --- a/docs/types/_internal_.ComposeFnParam.html +++ b/docs/types/_internal_.ComposeFnParam.html @@ -1 +1 @@ -ComposeFnParam | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Alias ComposeFnParam

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ComposeFnParam: (source: any) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • (source: any): void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • source: any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +ComposeFnParam | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Alias ComposeFnParam

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ComposeFnParam: (source: any) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • (source: any): void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • source: any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/types/_internal_.CreateNodeOptions.html b/docs/types/_internal_.CreateNodeOptions.html index 488c2a22..a59a326c 100644 --- a/docs/types/_internal_.CreateNodeOptions.html +++ b/docs/types/_internal_.CreateNodeOptions.html @@ -7,12 +7,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      aliasDuplicateObjects?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      During node construction, use anchors and aliases to keep strictly equal non-null objects as equivalent in YAML.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Default: true

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      anchorPrefix?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Default prefix for anchors.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      anchorPrefix?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Default prefix for anchors.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Default: 'a', resulting in anchors a1, a2, etc.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      flow?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Force the top-level collection node to use flow style.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      keepUndefined?: boolean | null

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Keep undefined object values when creating mappings, rather than +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      flow?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Force the top-level collection node to use flow style.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      keepUndefined?: boolean | null

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Keep undefined object values when creating mappings, rather than discarding them.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Default: false

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      onTagObj?: (tagObj: ScalarTag | CollectionTag) => void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      tag?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Specify the top-level collection type, e.g. "!!omap". Note that this +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      onTagObj?: (tagObj: ScalarTag | CollectionTag) => void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      tag?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Specify the top-level collection type, e.g. "!!omap". Note that this requires the corresponding tag to be available in this document's schema.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/types/_internal_.DateInput.html b/docs/types/_internal_.DateInput.html index 57432b91..4dc251dd 100644 --- a/docs/types/_internal_.DateInput.html +++ b/docs/types/_internal_.DateInput.html @@ -1,3 +1,3 @@ DateInput | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias DateInput

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        DateInput: number | string | Date

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        A Date object, a unix (epoch) timestamp in seconds, or a string that can be understood by the JavaScript Date constructor.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/types/_internal_.DefaultEventMap.html b/docs/types/_internal_.DefaultEventMap.html index 2e8fe65f..f5bdb342 100644 --- a/docs/types/_internal_.DefaultEventMap.html +++ b/docs/types/_internal_.DefaultEventMap.html @@ -1 +1 @@ -DefaultEventMap | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Alias DefaultEventMap

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          DefaultEventMap: [never]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +DefaultEventMap | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias DefaultEventMap

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            DefaultEventMap: [never]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/types/_internal_.DocumentOptions.html b/docs/types/_internal_.DocumentOptions.html index 3df1e1a2..c0247f46 100644 --- a/docs/types/_internal_.DocumentOptions.html +++ b/docs/types/_internal_.DocumentOptions.html @@ -3,8 +3,8 @@ version?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Optional Internal_directives

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            _directives?: Directives

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Used internally by Composer. If set and includes an explicit version, that overrides the version option.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            logLevel?: LogLevelId

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Control the logging level during parsing

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            logLevel?: LogLevelId

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Control the logging level during parsing

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Default: 'warn'

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            version?: "1.1" | "1.2" | "next"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The YAML version used by documents without a %YAML directive.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            version?: "1.1" | "1.2" | "next"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The YAML version used by documents without a %YAML directive.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Default: "1.2"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/functions/_internal_.whenNoAncestor.html b/docs/types/_internal_.DocumentSchema.html similarity index 63% rename from docs/functions/_internal_.whenNoAncestor.html rename to docs/types/_internal_.DocumentSchema.html index 89e12648..590b3311 100644 --- a/docs/functions/_internal_.whenNoAncestor.html +++ b/docs/types/_internal_.DocumentSchema.html @@ -1 +1 @@ -whenNoAncestor | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function whenNoAncestor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +DocumentSchema | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Alias DocumentSchema

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                DocumentSchema: 15

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/types/_internal_.DynamicValueBuilder.html b/docs/types/_internal_.DynamicValueBuilder.html index 11f42b4b..73617d7d 100644 --- a/docs/types/_internal_.DynamicValueBuilder.html +++ b/docs/types/_internal_.DynamicValueBuilder.html @@ -1 +1 @@ -DynamicValueBuilder | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Alias DynamicValueBuilder<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  DynamicValueBuilder: (context: ResolutionContext) => Resolved<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +DynamicValueBuilder | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Alias DynamicValueBuilder<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    DynamicValueBuilder: (context: ResolutionContext) => Resolved<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/types/_internal_.EndpointObjectProperty.html b/docs/types/_internal_.EndpointObjectProperty.html index 903cf085..66fb0ede 100644 --- a/docs/types/_internal_.EndpointObjectProperty.html +++ b/docs/types/_internal_.EndpointObjectProperty.html @@ -1 +1 @@ -EndpointObjectProperty | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Alias EndpointObjectProperty

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      EndpointObjectProperty:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | { [key: string]: EndpointObjectProperty }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | EndpointObjectProperty[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +EndpointObjectProperty | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias EndpointObjectProperty

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        EndpointObjectProperty:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | { [key: string]: EndpointObjectProperty }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | EndpointObjectProperty[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/types/_internal_.EndpointParameters.html b/docs/types/_internal_.EndpointParameters.html index 65b726f8..2f85c143 100644 --- a/docs/types/_internal_.EndpointParameters.html +++ b/docs/types/_internal_.EndpointParameters.html @@ -1 +1 @@ -EndpointParameters | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Alias EndpointParameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          EndpointParameters: { [name: string]: string | boolean | string[] }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type declaration

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +EndpointParameters | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias EndpointParameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            EndpointParameters: { [name: string]: string | boolean | string[] }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Declaration

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/types/_internal_.ErrorCallback.html b/docs/types/_internal_.ErrorCallback.html index d307de18..4e17c8d1 100644 --- a/docs/types/_internal_.ErrorCallback.html +++ b/docs/types/_internal_.ErrorCallback.html @@ -1 +1 @@ -ErrorCallback | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Alias ErrorCallback

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ErrorCallback: (error?: Error) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • (error?: Error): void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Optionalerror: Error

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +ErrorCallback | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Alias ErrorCallback

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ErrorCallback: (error?: Error) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • (error?: Error): void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Optionalerror: Error

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/types/_internal_.ErrorHandlingMiddleware.html b/docs/types/_internal_.ErrorHandlingMiddleware.html index 009e18ea..1a7ac6db 100644 --- a/docs/types/_internal_.ErrorHandlingMiddleware.html +++ b/docs/types/_internal_.ErrorHandlingMiddleware.html @@ -1 +1 @@ -ErrorHandlingMiddleware | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Alias ErrorHandlingMiddleware

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ErrorHandlingMiddleware: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      error: Error,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      req: Request,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      res: Response,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      next: NextFunction,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +ErrorHandlingMiddleware | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Alias ErrorHandlingMiddleware

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ErrorHandlingMiddleware: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        error: Error,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        req: Request,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        res: Response,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        next: NextFunction,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/types/_internal_.EventMap.html b/docs/types/_internal_.EventMap.html index 224f0ae4..8ae25e4b 100644 --- a/docs/types/_internal_.EventMap.html +++ b/docs/types/_internal_.EventMap.html @@ -1 +1 @@ -EventMap | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Alias EventMap<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      EventMap: Record<keyof T, any[]> | DefaultEventMap

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +EventMap | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias EventMap<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        EventMap: Record<keyof T, any[]> | DefaultEventMap

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/types/_internal_.Exclude.html b/docs/types/_internal_.Exclude.html index 66264e37..30fb6001 100644 --- a/docs/types/_internal_.Exclude.html +++ b/docs/types/_internal_.Exclude.html @@ -1,2 +1,2 @@ Exclude | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Alias Exclude<T, U>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Exclude: T extends U ? never : T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Exclude from T those types that are assignable to U

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • T
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • U

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • T
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • U

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/types/_internal_.Factory.html b/docs/types/_internal_.Factory.html index 8c604159..f9d27d7a 100644 --- a/docs/types/_internal_.Factory.html +++ b/docs/types/_internal_.Factory.html @@ -1 +1 @@ -Factory | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias Factory<TActivated, TArgs>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Factory: (...args: TArgs) => TActivated

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • TActivated
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • in TArgs extends unknown[] = any[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +Factory | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Alias Factory<TActivated, TArgs>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Factory: (...args: TArgs) => TActivated | Promise<TActivated>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • TActivated
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • in TArgs extends unknown[] = any[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/types/_internal_.FinallyFunction.html b/docs/types/_internal_.FinallyFunction.html index f565dc20..f1e1ab96 100644 --- a/docs/types/_internal_.FinallyFunction.html +++ b/docs/types/_internal_.FinallyFunction.html @@ -1 +1 @@ -FinallyFunction | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Alias FinallyFunction

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                FinallyFunction: (req: Request, res: Response) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +FinallyFunction | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Alias FinallyFunction

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  FinallyFunction: (req: Request, res: Response) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/types/_internal_.HandlerFunction.html b/docs/types/_internal_.HandlerFunction.html index b414e985..00c8b2c9 100644 --- a/docs/types/_internal_.HandlerFunction.html +++ b/docs/types/_internal_.HandlerFunction.html @@ -1 +1 @@ -HandlerFunction | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Alias HandlerFunction

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    HandlerFunction: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        req: Request,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        res: Response,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        next?: NextFunction,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ) => void | any | Promise<any>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +HandlerFunction | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Alias HandlerFunction

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      HandlerFunction: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          req: Request,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          res: Response,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          next?: NextFunction,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ) => void | any | Promise<any>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/types/_internal_.HeaderBag.html b/docs/types/_internal_.HeaderBag.html index 6c295af3..16fd27c9 100644 --- a/docs/types/_internal_.HeaderBag.html +++ b/docs/types/_internal_.HeaderBag.html @@ -10,4 +10,4 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The SDK may at any point during processing remove one of the object properties in favor of the other. The headers may or may not be combined, and the SDK will not deterministically select which header candidate to use.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/types/_internal_.HeadersInit.html b/docs/types/_internal_.HeadersInit.html index dd67007a..5919a465 100644 --- a/docs/types/_internal_.HeadersInit.html +++ b/docs/types/_internal_.HeadersInit.html @@ -1 +1 @@ -HeadersInit | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias HeadersInit

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        HeadersInit: [string, string][] | HeaderRecord | Headers

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +HeadersInit | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Alias HeadersInit

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          HeadersInit: [string, string][] | HeaderRecord | Headers

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/types/_internal_.HttpHandler.html b/docs/types/_internal_.HttpHandler.html index b822db35..5c415e9a 100644 --- a/docs/types/_internal_.HttpHandler.html +++ b/docs/types/_internal_.HttpHandler.html @@ -1 +1 @@ -HttpHandler | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias HttpHandler<HttpHandlerConfig>Internal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            HttpHandler: RequestHandler<HttpRequest, HttpResponse, HttpHandlerOptions> & {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                httpHandlerConfigs(): HttpHandlerConfig;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                updateHttpClientConfig(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    key: keyof HttpHandlerConfig,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    value: HttpHandlerConfig[keyof HttpHandlerConfig],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • HttpHandlerConfig extends object = {}

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +HttpHandler | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Alias HttpHandler<HttpHandlerConfig>Internal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              HttpHandler: RequestHandler<HttpRequest, HttpResponse, HttpHandlerOptions> & {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  httpHandlerConfigs(): HttpHandlerConfig;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  updateHttpClientConfig(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      key: keyof HttpHandlerConfig,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      value: HttpHandlerConfig[keyof HttpHandlerConfig],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • HttpHandlerConfig extends object = {}

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/types/_internal_.HttpHandlerUserInput.html b/docs/types/_internal_.HttpHandlerUserInput.html index 0007086c..ea6d4633 100644 --- a/docs/types/_internal_.HttpHandlerUserInput.html +++ b/docs/types/_internal_.HttpHandlerUserInput.html @@ -9,4 +9,4 @@ configured to use other default implementations such as Websocket or HTTP2.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The fallback type Record<string, unknown> is part of the union to allow passing constructor params to an unknown requestHandler type.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/types/_internal_.HttpLabelBitMask.html b/docs/types/_internal_.HttpLabelBitMask.html new file mode 100644 index 00000000..24d089ac --- /dev/null +++ b/docs/types/_internal_.HttpLabelBitMask.html @@ -0,0 +1 @@ +HttpLabelBitMask | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Alias HttpLabelBitMask

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                HttpLabelBitMask: 1

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Alias HttpPayloadBitMask

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  HttpPayloadBitMask: 16

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Alias HttpQueryParamsBitMask

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    HttpQueryParamsBitMask: 64

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/types/_internal_.HttpRequestOptions.html b/docs/types/_internal_.HttpRequestOptions.html index 90588e15..d1995e48 100644 --- a/docs/types/_internal_.HttpRequestOptions.html +++ b/docs/types/_internal_.HttpRequestOptions.html @@ -1 +1 @@ -HttpRequestOptions | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Alias HttpRequestOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      HttpRequestOptions: Partial<HttpMessage> & Partial<URI> & { method?: string }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +HttpRequestOptions | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias HttpRequestOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        HttpRequestOptions: Partial<HttpMessage> & Partial<URI> & { method?: string }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Alias HttpResponseCodeBitMask

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          HttpResponseCodeBitMask: 32

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/types/_internal_.IPVersion.html b/docs/types/_internal_.IPVersion.html index 09f19d7c..3ae38b9d 100644 --- a/docs/types/_internal_.IPVersion.html +++ b/docs/types/_internal_.IPVersion.html @@ -1 +1 @@ -IPVersion | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias IPVersion

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            IPVersion: "ipv4" | "ipv6"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +IPVersion | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Alias IPVersion

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              IPVersion: "ipv4" | "ipv6"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/types/_internal_.ISpecificationExtension.html b/docs/types/_internal_.ISpecificationExtension.html index fcbe49fc..c561ba91 100644 --- a/docs/types/_internal_.ISpecificationExtension.html +++ b/docs/types/_internal_.ISpecificationExtension.html @@ -1 +1 @@ -ISpecificationExtension | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Alias ISpecificationExtension

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type declaration

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +ISpecificationExtension | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Alias ISpecificationExtension

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Declaration

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Alias IdempotencyTokenBitMask

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    IdempotencyTokenBitMask: 4

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Alias IdempotentBitMask

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      IdempotentBitMask: 2

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/types/_internal_.IntegerHeaderValue.html b/docs/types/_internal_.IntegerHeaderValue.html index f86308c9..2fe6b44e 100644 --- a/docs/types/_internal_.IntegerHeaderValue.html +++ b/docs/types/_internal_.IntegerHeaderValue.html @@ -1 +1 @@ -IntegerHeaderValue | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias IntegerHeaderValue

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        IntegerHeaderValue: HeaderValue<"integer", number>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +IntegerHeaderValue | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Alias IntegerHeaderValue

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          IntegerHeaderValue: HeaderValue<"integer", number>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/types/_internal_.IsBound.html b/docs/types/_internal_.IsBound.html index de09aae7..ac44c981 100644 --- a/docs/types/_internal_.IsBound.html +++ b/docs/types/_internal_.IsBound.html @@ -1 +1 @@ -IsBound | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias IsBound

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            IsBound: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                serviceIdentifier: ServiceIdentifier,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                options?: IsBoundOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ) => boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +IsBound | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Alias IsBound

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              IsBound: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  serviceIdentifier: ServiceIdentifier,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  options?: IsBoundOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ) => boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/types/_internal_.Key.html b/docs/types/_internal_.Key.html index a930e218..a9a7fb91 100644 --- a/docs/types/_internal_.Key.html +++ b/docs/types/_internal_.Key.html @@ -1 +1 @@ -Key | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Alias Key<K, T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Key: T extends DefaultEventMap ? string | symbol : K | keyof T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • K
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +Key | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Alias Key<K, T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Key: T extends DefaultEventMap ? string | symbol : K | keyof T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • K
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/types/_internal_.Key2.html b/docs/types/_internal_.Key2.html index a652e54e..e36126b9 100644 --- a/docs/types/_internal_.Key2.html +++ b/docs/types/_internal_.Key2.html @@ -1 +1 @@ -Key2 | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Alias Key2<K, T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Key2: T extends DefaultEventMap ? string | symbol : K & keyof T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • K
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +Key2 | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Alias Key2<K, T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Key2: T extends DefaultEventMap ? string | symbol : K & keyof T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • K
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/types/_internal_.Listener.html b/docs/types/_internal_.Listener.html index df5eb756..406828bb 100644 --- a/docs/types/_internal_.Listener.html +++ b/docs/types/_internal_.Listener.html @@ -1 +1 @@ -Listener | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias Listener<K, T, F>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Listener: T extends DefaultEventMap
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ? F
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            : K extends keyof T
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ? T[K] extends unknown[] ? (...args: T[K]) => void : never
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                : never

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • K
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • T
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • F

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +Listener | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Alias Listener<K, T, F>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Listener: T extends DefaultEventMap
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ? F
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              : K extends keyof T
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ? T[K] extends unknown[] ? (...args: T[K]) => void : never
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  : never

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • K
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • T
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • F

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/types/_internal_.LoggerFunction.html b/docs/types/_internal_.LoggerFunction.html index 19b9ac20..55ff972f 100644 --- a/docs/types/_internal_.LoggerFunction.html +++ b/docs/types/_internal_.LoggerFunction.html @@ -1 +1 @@ -LoggerFunction | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias LoggerFunction

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            LoggerFunction: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                message?: any,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                additionalInfo?: LoggerFunctionAdditionalInfo,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +LoggerFunction | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Alias LoggerFunction

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              LoggerFunction: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  message?: any,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  additionalInfo?: LoggerFunctionAdditionalInfo,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/types/_internal_.LongHeaderValue.html b/docs/types/_internal_.LongHeaderValue.html index 549f9e8c..b4757baa 100644 --- a/docs/types/_internal_.LongHeaderValue.html +++ b/docs/types/_internal_.LongHeaderValue.html @@ -1 +1 @@ -LongHeaderValue | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Alias LongHeaderValue

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                LongHeaderValue: HeaderValue<"long", Int64>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +LongHeaderValue | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Alias LongHeaderValue

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  LongHeaderValue: HeaderValue<"long", Int64>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/types/_internal_.LookupFunction.html b/docs/types/_internal_.LookupFunction.html index 78ff3a10..94bc30bd 100644 --- a/docs/types/_internal_.LookupFunction.html +++ b/docs/types/_internal_.LookupFunction.html @@ -1 +1 @@ -LookupFunction | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Alias LookupFunction

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    LookupFunction: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        hostname: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        options: LookupOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        callback: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            err: ErrnoException | null,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            address: string | LookupAddress[],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            family?: number,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            hostname: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            options: LookupOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            callback: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                err: ErrnoException | null,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                address: string | LookupAddress[],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                family?: number,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ): void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +LookupFunction | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Alias LookupFunction

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      LookupFunction: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          hostname: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          options: LookupOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          callback: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              err: ErrnoException | null,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              address: string | LookupAddress[],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              family?: number,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              hostname: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              options: LookupOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              callback: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  err: ErrnoException | null,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  address: string | LookupAddress[],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  family?: number,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/types/_internal_.Lowercase.html b/docs/types/_internal_.Lowercase.html index 0e0fa7d6..3bdce4df 100644 --- a/docs/types/_internal_.Lowercase.html +++ b/docs/types/_internal_.Lowercase.html @@ -1,2 +1,2 @@ Lowercase | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias Lowercase<S>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Lowercase: intrinsic

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Convert string literal type to lowercase

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • S extends string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • S extends string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/types/_internal_.MemberSchema.html b/docs/types/_internal_.MemberSchema.html new file mode 100644 index 00000000..bd8d4416 --- /dev/null +++ b/docs/types/_internal_.MemberSchema.html @@ -0,0 +1,4 @@ +MemberSchema | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Alias MemberSchemaInternal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          MemberSchema: [SchemaRef, SchemaTraits]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Indicates the schema is a member of a parent Structure schema. +It may also have a set of member traits distinct from its target shape's traits.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          use $MemberSchema

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/types/_internal_.MessageHeaderValue.html b/docs/types/_internal_.MessageHeaderValue.html index 7db6109f..04448a5d 100644 --- a/docs/types/_internal_.MessageHeaderValue.html +++ b/docs/types/_internal_.MessageHeaderValue.html @@ -1 +1 @@ -MessageHeaderValue | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias MessageHeaderValue

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            MessageHeaderValue:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | BooleanHeaderValue
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | ByteHeaderValue
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | ShortHeaderValue
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | IntegerHeaderValue
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | LongHeaderValue
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | BinaryHeaderValue
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | StringHeaderValue
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | TimestampHeaderValue
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | UuidHeaderValue

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +MessageHeaderValue | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Alias MessageHeaderValue

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              MessageHeaderValue:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | BooleanHeaderValue
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | ByteHeaderValue
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | ShortHeaderValue
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | IntegerHeaderValue
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | LongHeaderValue
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | BinaryHeaderValue
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | StringHeaderValue
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | TimestampHeaderValue
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | UuidHeaderValue

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/types/_internal_.MessageHeaders.html b/docs/types/_internal_.MessageHeaders.html index c88eb18a..a579c98f 100644 --- a/docs/types/_internal_.MessageHeaders.html +++ b/docs/types/_internal_.MessageHeaders.html @@ -1 +1 @@ -MessageHeaders | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Alias MessageHeaders

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                MessageHeaders: Record<string, MessageHeaderValue>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +MessageHeaders | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Alias MessageHeaders

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  MessageHeaders: Record<string, MessageHeaderValue>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/types/_internal_.Middleware.html b/docs/types/_internal_.Middleware.html index 54400966..e130e9e4 100644 --- a/docs/types/_internal_.Middleware.html +++ b/docs/types/_internal_.Middleware.html @@ -1 +1 @@ -Middleware | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Alias Middleware

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Middleware: (req: Request, res: Response, next: NextFunction) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +Middleware | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Alias Middleware

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Middleware: (req: Request, res: Response, next: NextFunction) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/types/_internal_.NextFunction.html b/docs/types/_internal_.NextFunction.html index 48831938..f90e41fc 100644 --- a/docs/types/_internal_.NextFunction.html +++ b/docs/types/_internal_.NextFunction.html @@ -1 +1 @@ -NextFunction | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias NextFunction

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        NextFunction: () => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • (): void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +NextFunction | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Alias NextFunction

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          NextFunction: () => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • (): void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/types/_internal_.NodeType.html b/docs/types/_internal_.NodeType.html index c4899335..fd93e17f 100644 --- a/docs/types/_internal_.NodeType.html +++ b/docs/types/_internal_.NodeType.html @@ -1,2 +1,2 @@ NodeType | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias NodeType<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            NodeType: T extends string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | bigint
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | null
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | undefined
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ? Scalar<T>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                : T extends Date
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ? Scalar<string | Date>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    : T extends any[]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ? YAMLSeq<NodeType<T[number]>>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        : T extends { [key: string]: any }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ? YAMLMap<NodeType<keyof T>, NodeType<T[keyof T]>>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            : T extends { [key: number]: any }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ? YAMLMap<NodeType<keyof T>, NodeType<T[keyof T]>>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                : Node

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Utility type mapper

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/types/_internal_.NonSharedBuffer.html b/docs/types/_internal_.NonSharedBuffer.html new file mode 100644 index 00000000..ab525f03 --- /dev/null +++ b/docs/types/_internal_.NonSharedBuffer.html @@ -0,0 +1,3 @@ +NonSharedBuffer | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Alias NonSharedBuffer

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              NonSharedBuffer: Buffer<ArrayBuffer>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              This is intended for internal use, and will be removed once @types/node no longer supports +TypeScript versions earlier than 5.7.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/types/_internal_.NumericSchema.html b/docs/types/_internal_.NumericSchema.html new file mode 100644 index 00000000..a6b1704c --- /dev/null +++ b/docs/types/_internal_.NumericSchema.html @@ -0,0 +1,3 @@ +NumericSchema | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Alias NumericSchema

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                NumericSchema: 1

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Includes all numeric Smithy types except bigInteger and bigDecimal. +byte, short, integer, long, float, double, intEnum.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/types/_internal_.Omit.html b/docs/types/_internal_.Omit.html index 2796457f..e680912c 100644 --- a/docs/types/_internal_.Omit.html +++ b/docs/types/_internal_.Omit.html @@ -1,2 +1,2 @@ Omit | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Alias Omit<T, K>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Omit: Pick<T, Exclude<keyof T, K>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Construct a type with the properties of T except for those in type K.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • T
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • K extends keyof any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • T
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • K extends keyof any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/types/_internal_.OnActivation.html b/docs/types/_internal_.OnActivation.html index ce42e03f..662a7d61 100644 --- a/docs/types/_internal_.OnActivation.html +++ b/docs/types/_internal_.OnActivation.html @@ -1 +1 @@ -OnActivation | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Alias OnActivation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    OnActivation: <T>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        serviceIdentifier: ServiceIdentifier<T>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        activation: BindingActivation<T>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +OnActivation | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Alias OnActivation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      OnActivation: <T>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          serviceIdentifier: ServiceIdentifier<T>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          activation: BindingActivation<T>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/types/_internal_.OnDeactivation.html b/docs/types/_internal_.OnDeactivation.html index b9a6c846..2ac0a32e 100644 --- a/docs/types/_internal_.OnDeactivation.html +++ b/docs/types/_internal_.OnDeactivation.html @@ -1 +1 @@ -OnDeactivation | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias OnDeactivation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        OnDeactivation: <T>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            serviceIdentifier: ServiceIdentifier<T>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            deactivation: BindingDeactivation<T>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +OnDeactivation | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Alias OnDeactivation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          OnDeactivation: <T>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              serviceIdentifier: ServiceIdentifier<T>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              deactivation: BindingDeactivation<T>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/types/_internal_.OutgoingHttpHeader.html b/docs/types/_internal_.OutgoingHttpHeader.html index 050fb07d..3cfed314 100644 --- a/docs/types/_internal_.OutgoingHttpHeader.html +++ b/docs/types/_internal_.OutgoingHttpHeader.html @@ -1 +1 @@ -OutgoingHttpHeader | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias OutgoingHttpHeader

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            OutgoingHttpHeader: number | string | string[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +OutgoingHttpHeader | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Alias OutgoingHttpHeader

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              OutgoingHttpHeader: number | string | string[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/types/_internal_.ParseOptions.html b/docs/types/_internal_.ParseOptions.html index 08e1b490..cc3056f9 100644 --- a/docs/types/_internal_.ParseOptions.html +++ b/docs/types/_internal_.ParseOptions.html @@ -8,19 +8,19 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              intAsBigInt?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Whether integers should be parsed into BigInt rather than number values.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Default: false

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/BigInt

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              keepSourceTokens?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Include a srcToken value on each parsed Node, containing the CST token +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              keepSourceTokens?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Include a srcToken value on each parsed Node, containing the CST token that was composed into this node.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Default: false

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              lineCounter?: LineCounter

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              If set, newlines will be tracked, to allow for lineCounter.linePos(offset) +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              lineCounter?: LineCounter

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              If set, newlines will be tracked, to allow for lineCounter.linePos(offset) to provide the { line, col } positions within the input.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              prettyErrors?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Include line/col position & node type directly in parse errors.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              prettyErrors?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Include line/col position & node type directly in parse errors.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Default: true

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              strict?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Detect and report errors that are required by the YAML 1.2 spec, +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              strict?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Detect and report errors that are required by the YAML 1.2 spec, but are caused by unambiguous content.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Default: true

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              stringKeys?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Parse all mapping keys as strings. Treat all non-scalar keys as errors.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              stringKeys?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Parse all mapping keys as strings. Treat all non-scalar keys as errors.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Default: false

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              uniqueKeys?: boolean | ((a: ParsedNode, b: ParsedNode) => boolean)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              YAML requires map keys to be unique. By default, this is checked by +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              uniqueKeys?: boolean | ((a: ParsedNode, b: ParsedNode) => boolean)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              YAML requires map keys to be unique. By default, this is checked by comparing scalar values with ===; deep equality is not checked for aliases or collections. If merge keys are enabled by the schema, multiple << keys are allowed.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              @@ -28,4 +28,4 @@ customise. The comparator will be passed two ParsedNode values, and is expected to return a boolean indicating their equality.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Default: true

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/types/_internal_.Partial.html b/docs/types/_internal_.Partial.html index 2358f769..67dc548b 100644 --- a/docs/types/_internal_.Partial.html +++ b/docs/types/_internal_.Partial.html @@ -1,2 +1,2 @@ Partial | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Alias Partial<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Partial: { [P in keyof T]?: T[P] }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Make all properties in T optional

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/functions/_internal_.onDeactivation.html b/docs/types/_internal_.PartialOptions.html similarity index 64% rename from docs/functions/_internal_.onDeactivation.html rename to docs/types/_internal_.PartialOptions.html index 2a8dbabe..994683c7 100644 --- a/docs/functions/_internal_.onDeactivation.html +++ b/docs/types/_internal_.PartialOptions.html @@ -1 +1 @@ -onDeactivation | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function onDeactivation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +PartialOptions | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Alias PartialOptions<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    PartialOptions: { [K in keyof T]?: T[K] }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/types/_internal_.Pick.html b/docs/types/_internal_.Pick.html index 8431ed55..5542fafa 100644 --- a/docs/types/_internal_.Pick.html +++ b/docs/types/_internal_.Pick.html @@ -1,2 +1,2 @@ Pick | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Alias Pick<T, K>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Pick: { [P in K]: T[P] }

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • T
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • K extends keyof T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • T
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • K extends keyof T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/types/_internal_.Provider.html b/docs/types/_internal_.Provider.html index 4ddd2abb..0781480d 100644 --- a/docs/types/_internal_.Provider.html +++ b/docs/types/_internal_.Provider.html @@ -1 +1,4 @@ -Provider | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias Provider<TActivated, TArgs>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Provider: (...args: TArgs) => Promise<TActivated>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • TActivated
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • in TArgs extends unknown[] = any[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +Provider | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Alias Provider<TActivated, TArgs>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Provider: (...args: TArgs) => Promise<TActivated>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • TActivated
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • in TArgs extends unknown[] = any[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Use Factory instead. Provider will be removed in v8. +Providers exist for historical reasons from v5 when async dependencies weren't supported. +Factories are more flexible and can handle both sync and async operations.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/types/_internal_.QueryParameterBag.html b/docs/types/_internal_.QueryParameterBag.html index 42c94e4c..fd857984 100644 --- a/docs/types/_internal_.QueryParameterBag.html +++ b/docs/types/_internal_.QueryParameterBag.html @@ -1,4 +1,4 @@ QueryParameterBag | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias QueryParameterBag

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            QueryParameterBag: Record<string, string | string[] | null>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            A mapping of query parameter names to strings or arrays of strings, with the second being used when a parameter contains a list of values. Value can be set to null when query is not in key-value pairs shape

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/types/_internal_.Range.html b/docs/types/_internal_.Range.html index 7b2da840..974629d8 100644 --- a/docs/types/_internal_.Range.html +++ b/docs/types/_internal_.Range.html @@ -1,2 +1,2 @@ Range | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Alias Range

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Range: [number, number, number]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              [start, value-end, node-end]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/types/_internal_.ReadableStreamController.html b/docs/types/_internal_.ReadableStreamController.html index eef9e93f..3e44d0ec 100644 --- a/docs/types/_internal_.ReadableStreamController.html +++ b/docs/types/_internal_.ReadableStreamController.html @@ -1 +1 @@ -ReadableStreamController | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Alias ReadableStreamController<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ReadableStreamController: ReadableStreamDefaultController<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +ReadableStreamController | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Alias ReadableStreamController<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ReadableStreamController: ReadableStreamDefaultController<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/types/_internal_.ReadableStreamReadResult.html b/docs/types/_internal_.ReadableStreamReadResult.html index 6814c0d7..50a8b3c9 100644 --- a/docs/types/_internal_.ReadableStreamReadResult.html +++ b/docs/types/_internal_.ReadableStreamReadResult.html @@ -1 +1 @@ -ReadableStreamReadResult | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Alias ReadableStreamReadResult<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ReadableStreamReadResult:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | ReadableStreamReadValueResult<T>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | ReadableStreamReadDoneResult<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +ReadableStreamReadResult | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Alias ReadableStreamReadResult<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ReadableStreamReadResult:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | ReadableStreamReadValueResult<T>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | ReadableStreamReadDoneResult<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/types/_internal_.ReadableStreamReader.html b/docs/types/_internal_.ReadableStreamReader.html index 3dcb3a25..544b39f3 100644 --- a/docs/types/_internal_.ReadableStreamReader.html +++ b/docs/types/_internal_.ReadableStreamReader.html @@ -1 +1 @@ -ReadableStreamReader | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias ReadableStreamReader<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ReadableStreamReader: ReadableStreamDefaultReader<T> | ReadableStreamBYOBReader

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +ReadableStreamReader | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Alias ReadableStreamReader<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ReadableStreamReader: ReadableStreamDefaultReader<T> | ReadableStreamBYOBReader

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/types/_internal_.Readonly.html b/docs/types/_internal_.Readonly.html index 3dbf9586..88aca31e 100644 --- a/docs/types/_internal_.Readonly.html +++ b/docs/types/_internal_.Readonly.html @@ -1,2 +1,2 @@ Readonly | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias Readonly<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Readonly: { readonly [P in keyof T]: T[P] }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Make all properties in T readonly

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/types/_internal_.Rebind.html b/docs/types/_internal_.Rebind.html index 9d08d3e2..a598f2ab 100644 --- a/docs/types/_internal_.Rebind.html +++ b/docs/types/_internal_.Rebind.html @@ -1 +1 @@ -Rebind | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Alias Rebind

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Rebind: <T>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  serviceIdentifier: ServiceIdentifier<T>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ) => Promise<BindToFluentSyntax<T>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +Rebind | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Alias Rebind

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Rebind: <T>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    serviceIdentifier: ServiceIdentifier<T>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ) => Promise<BindToFluentSyntax<T>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/types/_internal_.RebindSync.html b/docs/types/_internal_.RebindSync.html index c446483d..78d15acc 100644 --- a/docs/types/_internal_.RebindSync.html +++ b/docs/types/_internal_.RebindSync.html @@ -1 +1 @@ -RebindSync | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Alias RebindSync

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  RebindSync: <T>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      serviceIdentifier: ServiceIdentifier<T>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ) => BindToFluentSyntax<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +RebindSync | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Alias RebindSync

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    RebindSync: <T>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        serviceIdentifier: ServiceIdentifier<T>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ) => BindToFluentSyntax<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/types/_internal_.Record.html b/docs/types/_internal_.Record.html index 3d1005e4..c2b00f0e 100644 --- a/docs/types/_internal_.Record.html +++ b/docs/types/_internal_.Record.html @@ -1,2 +1,2 @@ Record | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Alias Record<K, T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Record: { [P in K]: T }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Construct a type with a set of properties K of type T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • K extends keyof any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • K extends keyof any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/types/_internal_.RequestChecksumCalculation.html b/docs/types/_internal_.RequestChecksumCalculation.html index ad57bcac..0a5255cf 100644 --- a/docs/types/_internal_.RequestChecksumCalculation.html +++ b/docs/types/_internal_.RequestChecksumCalculation.html @@ -1 +1 @@ -RequestChecksumCalculation | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias RequestChecksumCalculation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        RequestChecksumCalculation: typeof RequestChecksumCalculation[keyof typeof RequestChecksumCalculation]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +RequestChecksumCalculation | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Alias RequestChecksumCalculation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          RequestChecksumCalculation: typeof RequestChecksumCalculation[keyof typeof RequestChecksumCalculation]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/types/_internal_.Required.html b/docs/types/_internal_.Required.html index 9f004f78..ed6a570c 100644 --- a/docs/types/_internal_.Required.html +++ b/docs/types/_internal_.Required.html @@ -1,2 +1,2 @@ Required | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias Required<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Required: { [P in keyof T]-?: T[P] }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Make all properties in T required

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/types/_internal_.ResponseChecksumValidation.html b/docs/types/_internal_.ResponseChecksumValidation.html index 9116beb5..3901b0d5 100644 --- a/docs/types/_internal_.ResponseChecksumValidation.html +++ b/docs/types/_internal_.ResponseChecksumValidation.html @@ -1 +1 @@ -ResponseChecksumValidation | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Alias ResponseChecksumValidation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ResponseChecksumValidation: typeof ResponseChecksumValidation[keyof typeof ResponseChecksumValidation]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +ResponseChecksumValidation | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Alias ResponseChecksumValidation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ResponseChecksumValidation: typeof ResponseChecksumValidation[keyof typeof ResponseChecksumValidation]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/types/_internal_.RetryErrorType.html b/docs/types/_internal_.RetryErrorType.html index 3a42323d..2cca88c8 100644 --- a/docs/types/_internal_.RetryErrorType.html +++ b/docs/types/_internal_.RetryErrorType.html @@ -1,4 +1,4 @@ -RetryErrorType | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Alias RetryErrorType

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  RetryErrorType: "TRANSIENT" | "THROTTLING" | "SERVER_ERROR" | "CLIENT_ERROR"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • "TRANSIENT"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    This is a connection level error such as a socket timeout, socket connect +RetryErrorType | ts-lambda-api - v2.5.2

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Alias RetryErrorType

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      RetryErrorType: "TRANSIENT" | "THROTTLING" | "SERVER_ERROR" | "CLIENT_ERROR"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • "TRANSIENT"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        This is a connection level error such as a socket timeout, socket connect error, tls negotiation timeout etc... Typically these should never be applied for non-idempotent request types since in this scenario, it's impossible to know whether the operation had @@ -9,4 +9,4 @@ by the client to be something that should be retried.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • "CLIENT_ERROR"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Doesn't count against any budgets. This could be something like a 401 challenge in Http.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/types/_internal_.ReturnType.html b/docs/types/_internal_.ReturnType.html index ea8f25fb..06b30fdb 100644 --- a/docs/types/_internal_.ReturnType.html +++ b/docs/types/_internal_.ReturnType.html @@ -1,2 +1,2 @@ ReturnType | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Alias ReturnType<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ReturnType: T extends (...args: any) => infer R ? R : any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Obtain the return type of a function type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • T extends (...args: any) => any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • T extends (...args: any) => any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/types/_internal_.Reviver.html b/docs/types/_internal_.Reviver.html index a80b52ae..26264972 100644 --- a/docs/types/_internal_.Reviver.html +++ b/docs/types/_internal_.Reviver.html @@ -1 +1 @@ -Reviver | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias Reviver

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Reviver: (key: unknown, value: unknown) => unknown

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • (key: unknown, value: unknown): unknown

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • key: unknown
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • value: unknown

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns unknown

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +Reviver | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Alias Reviver

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Reviver: (key: unknown, value: unknown) => unknown

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • (key: unknown, value: unknown): unknown

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • key: unknown
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • value: unknown

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns unknown

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/types/_internal_.S3ClientConfigType.html b/docs/types/_internal_.S3ClientConfigType.html index 036ddaac..b2dfd1ca 100644 --- a/docs/types/_internal_.S3ClientConfigType.html +++ b/docs/types/_internal_.S3ClientConfigType.html @@ -1 +1 @@ -S3ClientConfigType | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias S3ClientConfigType

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            S3ClientConfigType: Partial<SmithyConfiguration<HttpHandlerOptions>> & ClientDefaults & UserAgentInputConfig & FlexibleChecksumsInputConfig & RetryInputConfig & RegionInputConfig & HostHeaderInputConfig & EndpointInputConfig<
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                EndpointParameters,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            > & EventStreamSerdeInputConfig & HttpAuthSchemeInputConfig & S3InputConfig & ClientInputEndpointParameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +S3ClientConfigType | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Alias S3ClientConfigType

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              S3ClientConfigType: Partial<SmithyConfiguration<HttpHandlerOptions>> & ClientDefaults & UserAgentInputConfig & FlexibleChecksumsInputConfig & RetryInputConfig & RegionInputConfig & HostHeaderInputConfig & EndpointInputConfig<
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  EndpointParameters,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              > & EventStreamSerdeInputConfig & HttpAuthSchemeInputConfig & S3InputConfig & ClientInputEndpointParameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/types/_internal_.Schema.html b/docs/types/_internal_.Schema.html new file mode 100644 index 00000000..9c67e34d --- /dev/null +++ b/docs/types/_internal_.Schema.html @@ -0,0 +1,3 @@ +Schema | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Alias SchemaInternal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Schema:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | UnitSchema
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | TraitsSchema
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | SimpleSchema
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | ListSchema
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | MapSchema
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | StructureSchema
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | MemberSchema
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | OperationSchema
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | StaticSchema
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | NormalizedSchema

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                A schema is an object or value that describes how to serialize/deserialize data.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                use $Schema

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/types/_internal_.SchemaOptions.html b/docs/types/_internal_.SchemaOptions.html index 7d2e013b..1a0ef7f8 100644 --- a/docs/types/_internal_.SchemaOptions.html +++ b/docs/types/_internal_.SchemaOptions.html @@ -9,15 +9,15 @@ When stringifying, use scalar styles that are parsed correctly by the compat schema as well as the actual schema.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Default: null

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                customTags?: Tags | ((tags: Tags) => Tags) | null

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Array of additional tags to include in the schema, or a function that may +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                customTags?: Tags | ((tags: Tags) => Tags) | null

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Array of additional tags to include in the schema, or a function that may modify the schema's base tag array.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                merge?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Enable support for << merge keys.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                merge?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Enable support for << merge keys.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Default: false for YAML 1.2, true for earlier versions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                resolveKnownTags?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                When using the 'core' schema, support parsing values with these +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                resolveKnownTags?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                When using the 'core' schema, support parsing values with these explicit YAML 1.1 tags:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                !!binary, !!omap, !!pairs, !!set, !!timestamp.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Default true

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                schema?: string | Schema

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                The base schema to use.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                schema?: string | Schema

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                The base schema to use.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                The core library has built-in support for the following:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • 'failsafe': A minimal schema that parses all scalars as strings
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • @@ -28,9 +28,9 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  If using another (custom) schema, the customTags array needs to fully define the schema's tags.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Default: 'core' for YAML 1.2, 'yaml-1.1' for earlier versions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                sortMapEntries?: boolean | ((a: Pair, b: Pair) => number)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                When adding to or stringifying a map, sort the entries. +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                sortMapEntries?: boolean | ((a: Pair, b: Pair) => number)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                When adding to or stringifying a map, sort the entries. If true, sort by comparing key values with <. Does not affect item order when parsing.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Default: false

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                toStringDefaults?: ToStringOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Override default values for toString() options.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                toStringDefaults?: ToStringOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Override default values for toString() options.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/types/_internal_.SchemaRef.html b/docs/types/_internal_.SchemaRef.html new file mode 100644 index 00000000..34fbe193 --- /dev/null +++ b/docs/types/_internal_.SchemaRef.html @@ -0,0 +1,5 @@ +SchemaRef | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Alias SchemaRefInternal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  SchemaRef: Schema | (() => Schema)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  A schema "reference" is either a schema or a function that +provides a schema. This is useful for lazy loading, and to allow +code generation to define schema out of dependency order.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  use $SchemaRef

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/types/_internal_.SchemaTraits.html b/docs/types/_internal_.SchemaTraits.html new file mode 100644 index 00000000..244d322a --- /dev/null +++ b/docs/types/_internal_.SchemaTraits.html @@ -0,0 +1,5 @@ +SchemaTraits | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Alias SchemaTraits

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    SchemaTraits: TraitBitVector | SchemaTraitsObject

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Traits attached to schema objects.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    When this is a number, it refers to a pre-allocated +trait combination that is equivalent to one of the +object type's variations.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/types/_internal_.SchemaTraitsObject.html b/docs/types/_internal_.SchemaTraitsObject.html new file mode 100644 index 00000000..35592270 --- /dev/null +++ b/docs/types/_internal_.SchemaTraitsObject.html @@ -0,0 +1,32 @@ +SchemaTraitsObject | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Alias SchemaTraitsObject

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      See https://smithy.io/2.0/trait-index.html for individual definitions.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      type SchemaTraitsObject = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          endpoint?: [string];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          error?: "client" | "server";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          eventHeader?: 1;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          eventPayload?: 1;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          http?: [string, string, number];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          httpHeader?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          httpLabel?: 1;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          httpPayload?: 1;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          httpPrefixHeaders?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          httpQuery?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          httpQueryParams?: 1;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          httpResponseCode?: 1;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          idempotencyToken?: 1;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          idempotent?: 1;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          jsonName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          mediaType?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          sensitive?: 1;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          sparse?: 1;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          streaming?: 1;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          timestampFormat?: never;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          xmlAttribute?: 1;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          xmlFlattened?: 1;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          xmlName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          xmlNamespace?: [string, string];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          [traitName: string]: unknown;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [traitName: string]: unknown
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      endpoint? +error? +eventHeader? +eventPayload? +http? +httpHeader? +httpLabel? +httpPayload? +httpPrefixHeaders? +httpQuery? +httpQueryParams? +httpResponseCode? +idempotencyToken? +idempotent? +jsonName? +mediaType? +sensitive? +sparse? +streaming? +timestampFormat? +xmlAttribute? +xmlFlattened? +xmlName? +xmlNamespace? +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      endpoint?: [string]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      [hostPrefix]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      error?: "client" | "server"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      eventHeader?: 1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      eventPayload?: 1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      http?: [string, string, number]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      [method, path, statusCode]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      httpHeader?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      httpLabel?: 1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      httpPayload?: 1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      httpPrefixHeaders?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      httpQuery?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      httpQueryParams?: 1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      httpResponseCode?: 1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      idempotencyToken?: 1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      idempotent?: 1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      jsonName?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      mediaType?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      sensitive?: 1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      sparse?: 1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      streaming?: 1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      timestampFormat?: never

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      timestampFormat is expressed by the schema sentinel values of 4, 5, 6, and 7, +and not contained in trait objects.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      use schema value.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      xmlAttribute?: 1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      xmlFlattened?: 1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      xmlName?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      xmlNamespace?: [string, string]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      [prefix, uri]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/types/_internal_.SecureVersion.html b/docs/types/_internal_.SecureVersion.html index e447a802..39558fcd 100644 --- a/docs/types/_internal_.SecureVersion.html +++ b/docs/types/_internal_.SecureVersion.html @@ -1 +1 @@ -SecureVersion | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias SecureVersion

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        SecureVersion: "TLSv1.3" | "TLSv1.2" | "TLSv1.1" | "TLSv1"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +SecureVersion | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Alias SecureVersion

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          SecureVersion: "TLSv1.3" | "TLSv1.2" | "TLSv1.1" | "TLSv1"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/types/_internal_.SensitiveBitMask.html b/docs/types/_internal_.SensitiveBitMask.html new file mode 100644 index 00000000..660be20f --- /dev/null +++ b/docs/types/_internal_.SensitiveBitMask.html @@ -0,0 +1 @@ +SensitiveBitMask | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias SensitiveBitMask

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            SensitiveBitMask: 8

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/types/_internal_.SerializerFunction.html b/docs/types/_internal_.SerializerFunction.html index 97968825..dc3c0637 100644 --- a/docs/types/_internal_.SerializerFunction.html +++ b/docs/types/_internal_.SerializerFunction.html @@ -1 +1 @@ -SerializerFunction | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Alias SerializerFunction

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              SerializerFunction: (body: object) => string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • (body: object): string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • body: object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +SerializerFunction | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Alias SerializerFunction

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                SerializerFunction: (body: object) => string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • (body: object): string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • body: object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/types/_internal_.ShapeName.html b/docs/types/_internal_.ShapeName.html new file mode 100644 index 00000000..517eb3e0 --- /dev/null +++ b/docs/types/_internal_.ShapeName.html @@ -0,0 +1 @@ +ShapeName | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Alias ShapeName

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ShapeName: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/types/_internal_.ShapeNamespace.html b/docs/types/_internal_.ShapeNamespace.html new file mode 100644 index 00000000..3737c46a --- /dev/null +++ b/docs/types/_internal_.ShapeNamespace.html @@ -0,0 +1 @@ +ShapeNamespace | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Alias ShapeNamespace

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ShapeNamespace: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/types/_internal_.ShortHeaderValue.html b/docs/types/_internal_.ShortHeaderValue.html index cd34bda5..1d0527df 100644 --- a/docs/types/_internal_.ShortHeaderValue.html +++ b/docs/types/_internal_.ShortHeaderValue.html @@ -1 +1 @@ -ShortHeaderValue | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Alias ShortHeaderValue

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ShortHeaderValue: HeaderValue<"short", number>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +ShortHeaderValue | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias ShortHeaderValue

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ShortHeaderValue: HeaderValue<"short", number>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/types/_internal_.SimpleSchema.html b/docs/types/_internal_.SimpleSchema.html new file mode 100644 index 00000000..0c140cd6 --- /dev/null +++ b/docs/types/_internal_.SimpleSchema.html @@ -0,0 +1,3 @@ +SimpleSchema | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Alias SimpleSchema

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          SimpleSchema:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | BlobSchemas
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | StringSchema
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | BooleanSchema
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | NumericSchema
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | BigIntegerSchema
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | BigDecimalSchema
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | DocumentSchema
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | TimestampSchemas
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Simple schemas are those corresponding to simple Smithy types.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          https://smithy.io/2.0/spec/simple-types.html

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/types/_internal_.SocketConnectOpts.html b/docs/types/_internal_.SocketConnectOpts.html index 9f826491..f4cd32ce 100644 --- a/docs/types/_internal_.SocketConnectOpts.html +++ b/docs/types/_internal_.SocketConnectOpts.html @@ -1 +1 @@ -SocketConnectOpts | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias SocketConnectOpts

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            SocketConnectOpts: TcpSocketConnectOpts | IpcSocketConnectOpts

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +SocketConnectOpts | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Alias SocketConnectOpts

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              SocketConnectOpts: TcpSocketConnectOpts | IpcSocketConnectOpts

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/types/_internal_.SocketReadyState.html b/docs/types/_internal_.SocketReadyState.html index b2983cbb..14f2d99c 100644 --- a/docs/types/_internal_.SocketReadyState.html +++ b/docs/types/_internal_.SocketReadyState.html @@ -1 +1 @@ -SocketReadyState | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Alias SocketReadyState

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                SocketReadyState: "opening" | "open" | "readOnly" | "writeOnly" | "closed"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +SocketReadyState | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Alias SocketReadyState

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  SocketReadyState: "opening" | "open" | "readOnly" | "writeOnly" | "closed"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/types/_internal_.SourceData.html b/docs/types/_internal_.SourceData.html index c15fa07e..22c1a1b6 100644 --- a/docs/types/_internal_.SourceData.html +++ b/docs/types/_internal_.SourceData.html @@ -1 +1 @@ -SourceData | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Alias SourceData

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    SourceData: string | ArrayBuffer | ArrayBufferView

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +SourceData | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Alias SourceData

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      SourceData: string | ArrayBuffer | ArrayBufferView

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias StaticErrorSchema

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        StaticErrorSchema: [
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            StaticSchemaIdError,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ShapeNamespace,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ShapeName,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            SchemaTraits,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            string[],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            $SchemaRef[],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/types/_internal_.StaticListSchema.html b/docs/types/_internal_.StaticListSchema.html new file mode 100644 index 00000000..48e62398 --- /dev/null +++ b/docs/types/_internal_.StaticListSchema.html @@ -0,0 +1 @@ +StaticListSchema | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Alias StaticListSchema

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          StaticListSchema: [
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              StaticSchemaIdList,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ShapeNamespace,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ShapeName,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              SchemaTraits,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              $SchemaRef,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/types/_internal_.StaticMapSchema.html b/docs/types/_internal_.StaticMapSchema.html new file mode 100644 index 00000000..7ffa0dd5 --- /dev/null +++ b/docs/types/_internal_.StaticMapSchema.html @@ -0,0 +1 @@ +StaticMapSchema | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias StaticMapSchema

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            StaticMapSchema: [
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                StaticSchemaIdMap,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ShapeNamespace,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ShapeName,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                SchemaTraits,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                $SchemaRef,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                $SchemaRef,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Alias StaticOperationSchema

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              StaticOperationSchema: [
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  StaticSchemaIdOperation,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ShapeNamespace,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ShapeName,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  SchemaTraits,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  $SchemaRef,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  $SchemaRef,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/types/_internal_.StaticSchema.html b/docs/types/_internal_.StaticSchema.html new file mode 100644 index 00000000..71cfbce3 --- /dev/null +++ b/docs/types/_internal_.StaticSchema.html @@ -0,0 +1 @@ +StaticSchema | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Alias StaticSchema

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                StaticSchema:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | StaticSimpleSchema
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | StaticListSchema
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | StaticMapSchema
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | StaticStructureSchema
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | StaticErrorSchema
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | StaticOperationSchema

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Alias StaticSchemaIdError

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  StaticSchemaIdError: -3

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Alias StaticSchemaIdList

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    StaticSchemaIdList: 1

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Alias StaticSchemaIdMap

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      StaticSchemaIdMap: 2

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias StaticSchemaIdOperation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        StaticSchemaIdOperation: 9

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/types/_internal_.StaticSchemaIdSimple.html b/docs/types/_internal_.StaticSchemaIdSimple.html new file mode 100644 index 00000000..3201f16b --- /dev/null +++ b/docs/types/_internal_.StaticSchemaIdSimple.html @@ -0,0 +1 @@ +StaticSchemaIdSimple | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Alias StaticSchemaIdSimple

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          StaticSchemaIdSimple: 0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/types/_internal_.StaticSchemaIdStruct.html b/docs/types/_internal_.StaticSchemaIdStruct.html new file mode 100644 index 00000000..87f4193f --- /dev/null +++ b/docs/types/_internal_.StaticSchemaIdStruct.html @@ -0,0 +1 @@ +StaticSchemaIdStruct | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias StaticSchemaIdStruct

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            StaticSchemaIdStruct: 3

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Alias StaticSimpleSchema

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              StaticSimpleSchema: [
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  StaticSchemaIdSimple,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ShapeNamespace,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ShapeName,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  SchemaTraits,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  $SchemaRef,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Alias StaticStructureSchema

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                StaticStructureSchema: [
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    StaticSchemaIdStruct,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ShapeNamespace,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ShapeName,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    SchemaTraits,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    string[],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    $SchemaRef[],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/types/_internal_.Stream.PipelineCallback.html b/docs/types/_internal_.Stream.PipelineCallback.html index f3367993..ea8edf2d 100644 --- a/docs/types/_internal_.Stream.PipelineCallback.html +++ b/docs/types/_internal_.Stream.PipelineCallback.html @@ -1 +1 @@ -PipelineCallback | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Alias PipelineCallback<S>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  PipelineCallback: S extends PipelineDestinationPromiseFunction<any, infer P>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ? (err: ErrnoException | null, value: P) => void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      : (err: ErrnoException | null) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +PipelineCallback | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Alias PipelineCallback<S>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    PipelineCallback: S extends PipelineDestinationPromiseFunction<any, infer P>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ? (err: ErrnoException | null, value: P) => void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        : (err: ErrnoException | null) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/types/_internal_.Stream.PipelineDestination.html b/docs/types/_internal_.Stream.PipelineDestination.html index 98555932..28517a9b 100644 --- a/docs/types/_internal_.Stream.PipelineDestination.html +++ b/docs/types/_internal_.Stream.PipelineDestination.html @@ -1 +1 @@ -PipelineDestination | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Alias PipelineDestination<S, P>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      PipelineDestination: S extends PipelineTransformSource<infer ST>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ?
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | WritableStream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | PipelineDestinationIterableFunction<ST>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | PipelineDestinationPromiseFunction<ST, P>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          : never

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +PipelineDestination | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias PipelineDestination<S, P>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        PipelineDestination: S extends PipelineTransformSource<infer ST>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ?
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | WritableStream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | PipelineDestinationIterableFunction<ST>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | PipelineDestinationPromiseFunction<ST, P>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            : never

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/types/_internal_.Stream.PipelineDestinationIterableFunction.html b/docs/types/_internal_.Stream.PipelineDestinationIterableFunction.html index d4c01039..8e82e836 100644 --- a/docs/types/_internal_.Stream.PipelineDestinationIterableFunction.html +++ b/docs/types/_internal_.Stream.PipelineDestinationIterableFunction.html @@ -1 +1 @@ -PipelineDestinationIterableFunction | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Alias PipelineDestinationIterableFunction<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          PipelineDestinationIterableFunction: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              source: AsyncIterable<T>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ) => AsyncIterable<any>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +PipelineDestinationIterableFunction | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias PipelineDestinationIterableFunction<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            PipelineDestinationIterableFunction: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                source: AsyncIterable<T>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ) => AsyncIterable<any>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/types/_internal_.Stream.PipelineDestinationPromiseFunction.html b/docs/types/_internal_.Stream.PipelineDestinationPromiseFunction.html index 3dcdec10..a6c02bb5 100644 --- a/docs/types/_internal_.Stream.PipelineDestinationPromiseFunction.html +++ b/docs/types/_internal_.Stream.PipelineDestinationPromiseFunction.html @@ -1 +1 @@ -PipelineDestinationPromiseFunction | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Alias PipelineDestinationPromiseFunction<T, P>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              PipelineDestinationPromiseFunction: (source: AsyncIterable<T>) => Promise<P>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • T
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • P

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +PipelineDestinationPromiseFunction | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Alias PipelineDestinationPromiseFunction<T, P>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                PipelineDestinationPromiseFunction: (source: AsyncIterable<T>) => Promise<P>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • T
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • P

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/types/_internal_.Stream.PipelinePromise.html b/docs/types/_internal_.Stream.PipelinePromise.html index 93c2f5ac..e0c684fc 100644 --- a/docs/types/_internal_.Stream.PipelinePromise.html +++ b/docs/types/_internal_.Stream.PipelinePromise.html @@ -1 +1 @@ -PipelinePromise | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Alias PipelinePromise<S>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  PipelinePromise: S extends PipelineDestinationPromiseFunction<any, infer P>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ? Promise<P>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      : Promise<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +PipelinePromise | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Alias PipelinePromise<S>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    PipelinePromise: S extends PipelineDestinationPromiseFunction<any, infer P>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ? Promise<P>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        : Promise<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/types/_internal_.Stream.PipelineSource.html b/docs/types/_internal_.Stream.PipelineSource.html index 9a8dcb21..68558d4e 100644 --- a/docs/types/_internal_.Stream.PipelineSource.html +++ b/docs/types/_internal_.Stream.PipelineSource.html @@ -1 +1 @@ -PipelineSource | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Alias PipelineSource<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      PipelineSource:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | Iterable<T>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | AsyncIterable<T>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | ReadableStream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | PipelineSourceFunction<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +PipelineSource | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias PipelineSource<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        PipelineSource:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | Iterable<T>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | AsyncIterable<T>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | ReadableStream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | PipelineSourceFunction<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/types/_internal_.Stream.PipelineSourceFunction.html b/docs/types/_internal_.Stream.PipelineSourceFunction.html index c46dcbb7..c9cceaff 100644 --- a/docs/types/_internal_.Stream.PipelineSourceFunction.html +++ b/docs/types/_internal_.Stream.PipelineSourceFunction.html @@ -1 +1 @@ -PipelineSourceFunction | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Alias PipelineSourceFunction<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          PipelineSourceFunction: () => Iterable<T> | AsyncIterable<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +PipelineSourceFunction | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias PipelineSourceFunction<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            PipelineSourceFunction: () => Iterable<T> | AsyncIterable<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/types/_internal_.Stream.PipelineTransform.html b/docs/types/_internal_.Stream.PipelineTransform.html index 6bea8091..8bd754be 100644 --- a/docs/types/_internal_.Stream.PipelineTransform.html +++ b/docs/types/_internal_.Stream.PipelineTransform.html @@ -1 +1 @@ -PipelineTransform | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Alias PipelineTransform<S, U>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              PipelineTransform:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | ReadWriteStream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          source: S extends (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ...args: any[],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ) => Iterable<infer ST> | AsyncIterable<infer ST>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ? AsyncIterable<ST>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              : S,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ) => AsyncIterable<U>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  )

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +PipelineTransform | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Alias PipelineTransform<S, U>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                PipelineTransform:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | ReadWriteStream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            source: S extends (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ...args: any[],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ) => Iterable<infer ST> | AsyncIterable<infer ST>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ? AsyncIterable<ST>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                : S,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ) => AsyncIterable<U>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    )

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/types/_internal_.Stream.PipelineTransformSource.html b/docs/types/_internal_.Stream.PipelineTransformSource.html index 7ce41210..3c23be77 100644 --- a/docs/types/_internal_.Stream.PipelineTransformSource.html +++ b/docs/types/_internal_.Stream.PipelineTransformSource.html @@ -1 +1 @@ -PipelineTransformSource | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Alias PipelineTransformSource<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  PipelineTransformSource: PipelineSource<T> | PipelineTransform<any, T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +PipelineTransformSource | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Alias PipelineTransformSource<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    PipelineTransformSource: PipelineSource<T> | PipelineTransform<any, T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/types/_internal_.Stream.TransformCallback.html b/docs/types/_internal_.Stream.TransformCallback.html index 16cebca2..083d3d38 100644 --- a/docs/types/_internal_.Stream.TransformCallback.html +++ b/docs/types/_internal_.Stream.TransformCallback.html @@ -1 +1 @@ -TransformCallback | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Alias TransformCallback

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      TransformCallback: (error?: Error | null, data?: any) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • (error?: Error | null, data?: any): void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Optionalerror: Error | null
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Optionaldata: any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +TransformCallback | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias TransformCallback

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        TransformCallback: (error?: Error | null, data?: any) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • (error?: Error | null, data?: any): void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Optionalerror: Error | null
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Optionaldata: any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/types/_internal_.StreamingBlobSchema.html b/docs/types/_internal_.StreamingBlobSchema.html new file mode 100644 index 00000000..1380c3e4 --- /dev/null +++ b/docs/types/_internal_.StreamingBlobSchema.html @@ -0,0 +1 @@ +StreamingBlobSchema | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Alias StreamingBlobSchema

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          StreamingBlobSchema: 42

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/types/_internal_.StringHeaderValue.html b/docs/types/_internal_.StringHeaderValue.html index aa51feda..951ad0f8 100644 --- a/docs/types/_internal_.StringHeaderValue.html +++ b/docs/types/_internal_.StringHeaderValue.html @@ -1 +1 @@ -StringHeaderValue | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias StringHeaderValue

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            StringHeaderValue: HeaderValue<"string", string>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +StringHeaderValue | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Alias StringHeaderValue

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              StringHeaderValue: HeaderValue<"string", string>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/types/_internal_.StringSchema.html b/docs/types/_internal_.StringSchema.html new file mode 100644 index 00000000..9cb16d1b --- /dev/null +++ b/docs/types/_internal_.StringSchema.html @@ -0,0 +1,2 @@ +StringSchema | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Alias StringSchema

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                StringSchema: 0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Includes string and enum Smithy types.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Alias TimestampDateTimeSchema

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  TimestampDateTimeSchema: 5

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/types/_internal_.TimestampDefaultSchema.html b/docs/types/_internal_.TimestampDefaultSchema.html new file mode 100644 index 00000000..8bb34426 --- /dev/null +++ b/docs/types/_internal_.TimestampDefaultSchema.html @@ -0,0 +1,2 @@ +TimestampDefaultSchema | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Alias TimestampDefaultSchema

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    TimestampDefaultSchema: 4

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Smithy type timestamp, in JS as native Date object.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/types/_internal_.TimestampEpochSecondsSchema.html b/docs/types/_internal_.TimestampEpochSecondsSchema.html new file mode 100644 index 00000000..9379fb3c --- /dev/null +++ b/docs/types/_internal_.TimestampEpochSecondsSchema.html @@ -0,0 +1 @@ +TimestampEpochSecondsSchema | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Alias TimestampEpochSecondsSchema

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      TimestampEpochSecondsSchema: 7

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/types/_internal_.TimestampFunction.html b/docs/types/_internal_.TimestampFunction.html index b5016e86..855a8baa 100644 --- a/docs/types/_internal_.TimestampFunction.html +++ b/docs/types/_internal_.TimestampFunction.html @@ -1 +1 @@ -TimestampFunction | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias TimestampFunction

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        TimestampFunction: () => string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • (): string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Returns string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +TimestampFunction | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Alias TimestampFunction

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          TimestampFunction: () => string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • (): string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Returns string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/types/_internal_.TimestampHeaderValue.html b/docs/types/_internal_.TimestampHeaderValue.html index b1ffdc08..7e35d8e7 100644 --- a/docs/types/_internal_.TimestampHeaderValue.html +++ b/docs/types/_internal_.TimestampHeaderValue.html @@ -1 +1 @@ -TimestampHeaderValue | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias TimestampHeaderValue

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            TimestampHeaderValue: HeaderValue<"timestamp", Date>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +TimestampHeaderValue | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Alias TimestampHeaderValue

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              TimestampHeaderValue: HeaderValue<"timestamp", Date>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Alias TimestampHttpDateSchema

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                TimestampHttpDateSchema: 6

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/types/_internal_.TimestampSchemas.html b/docs/types/_internal_.TimestampSchemas.html new file mode 100644 index 00000000..977da2b4 --- /dev/null +++ b/docs/types/_internal_.TimestampSchemas.html @@ -0,0 +1,3 @@ +TimestampSchemas | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Alias TimestampSchemas

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  TimestampSchemas:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | TimestampDefaultSchema
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | TimestampDateTimeSchema
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | TimestampHttpDateSchema
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | TimestampEpochSecondsSchema

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Sentinel value for Timestamp schema. +"Default" means unspecified and to use the protocol serializer's default format.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/types/_internal_.ToJSOptions.html b/docs/types/_internal_.ToJSOptions.html index 9371b945..5ed58700 100644 --- a/docs/types/_internal_.ToJSOptions.html +++ b/docs/types/_internal_.ToJSOptions.html @@ -4,11 +4,11 @@ reviver?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  mapAsMap?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Use Map rather than Object to represent mappings.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Default: false

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  maxAliasCount?: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Prevent exponential entity expansion attacks by limiting data aliasing count; +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  maxAliasCount?: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Prevent exponential entity expansion attacks by limiting data aliasing count; set to -1 to disable checks; 0 disallows all alias nodes.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Default: 100

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  onAnchor?: (value: unknown, count: number) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  If defined, called with the resolved value and reference count for +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  onAnchor?: (value: unknown, count: number) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  If defined, called with the resolved value and reference count for each anchor in the document.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  reviver?: Reviver

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Optional function that may filter or modify the output JS value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  reviver?: Reviver

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Optional function that may filter or modify the output JS value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/parse#using_the_reviver_parameter

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/types/_internal_.ToStringOptions.html b/docs/types/_internal_.ToStringOptions.html index 02034ccc..733873ad 100644 --- a/docs/types/_internal_.ToStringOptions.html +++ b/docs/types/_internal_.ToStringOptions.html @@ -20,23 +20,23 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  blockQuote?: boolean | "folded" | "literal"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Use block quote styles for scalar values where applicable. Set to false to disable block quotes completely.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Default: true

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  collectionStyle?: "any" | "block" | "flow"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Enforce 'block' or 'flow' style on maps and sequences. +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  collectionStyle?: "any" | "block" | "flow"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Enforce 'block' or 'flow' style on maps and sequences. Empty collections will always be stringified as {} or [].

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Default: 'any', allowing each node to set its style separately with its flow: boolean (default false) property.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  commentString?: (comment: string) => string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Comment stringifier. +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  commentString?: (comment: string) => string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Comment stringifier. Output should be valid for the current schema.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  By default, empty comment lines are left empty, lines consisting of a single space are replaced by #, and all other lines are prefixed with a #.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  defaultKeyType?: Type | null

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The default type of string literal used to stringify implicit key values. +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  defaultKeyType?: Type | null

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The default type of string literal used to stringify implicit key values. Output may use other types if required to fully represent the value.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  If null, the value of defaultStringType is used.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Default: null

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  defaultStringType?: Type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The default type of string literal used to stringify values in general. +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  defaultStringType?: Type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The default type of string literal used to stringify values in general. Output may use other types if required to fully represent the value.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Default: 'PLAIN'

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  directives?: boolean | null

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Include directives in the output.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  directives?: boolean | null

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Include directives in the output.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • If true, at least the document-start marker --- is always included. This does not force the %YAML directive to be included. To do that, @@ -47,42 +47,42 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • If null, directives and marker may be included if required.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Default: null

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  doubleQuotedAsJSON?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Restrict double-quoted strings to use JSON-compatible syntax.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  doubleQuotedAsJSON?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Restrict double-quoted strings to use JSON-compatible syntax.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Default: false

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  doubleQuotedMinMultiLineLength?: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Minimum length for double-quoted strings to use multiple lines to +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  doubleQuotedMinMultiLineLength?: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Minimum length for double-quoted strings to use multiple lines to represent the value. Ignored if doubleQuotedAsJSON is set.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Default: 40

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  falseStr?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  String representation for false. +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  falseStr?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  String representation for false. With the core schema, use 'false', 'False', or 'FALSE'.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Default: 'false'

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  flowCollectionPadding?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  When true, a single space of padding will be added inside the delimiters +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  flowCollectionPadding?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  When true, a single space of padding will be added inside the delimiters of non-empty single-line flow collections.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Default: true

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  indent?: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The number of spaces to use when indenting code.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  indent?: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The number of spaces to use when indenting code.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Default: 2

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  indentSeq?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Whether block sequences should be indented.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  indentSeq?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Whether block sequences should be indented.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Default: true

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  lineWidth?: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Maximum line width (set to 0 to disable folding).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  lineWidth?: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Maximum line width (set to 0 to disable folding).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  This is a soft limit, as only double-quoted semantics allow for inserting a line break in the middle of a word, as well as being influenced by the minContentWidth option.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Default: 80

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  minContentWidth?: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Minimum line width for highly-indented content (set to 0 to disable).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  minContentWidth?: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Minimum line width for highly-indented content (set to 0 to disable).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Default: 20

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  nullStr?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  String representation for null. +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  nullStr?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  String representation for null. With the core schema, use 'null', 'Null', 'NULL', '~', or an empty string ''.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Default: 'null'

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  simpleKeys?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Require keys to be scalars and to use implicit rather than explicit notation.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  simpleKeys?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Require keys to be scalars and to use implicit rather than explicit notation.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Default: false

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  singleQuote?: boolean | null

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Use 'single quote' rather than "double quote" where applicable. +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  singleQuote?: boolean | null

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Use 'single quote' rather than "double quote" where applicable. Set to false to disable single quotes completely.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Default: null

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  trueStr?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  String representation for true. +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  trueStr?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  String representation for true. With the core schema, use 'true', 'True', or 'TRUE'.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Default: 'true'

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  verifyAliasOrder?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The anchor used by an alias must be defined before the alias node. As it's +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  verifyAliasOrder?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The anchor used by an alias must be defined before the alias node. As it's possible for the document to be modified manually, the order may be verified during stringification.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Default: 'true'

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/types/_internal_.TraitBitVector.html b/docs/types/_internal_.TraitBitVector.html new file mode 100644 index 00000000..edc67447 --- /dev/null +++ b/docs/types/_internal_.TraitBitVector.html @@ -0,0 +1,12 @@ +TraitBitVector | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Alias TraitBitVector

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    TraitBitVector:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | HttpLabelBitMask
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | IdempotentBitMask
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | IdempotencyTokenBitMask
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | SensitiveBitMask
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | HttpPayloadBitMask
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | HttpResponseCodeBitMask
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | HttpQueryParamsBitMask
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    A bitvector representing a traits object.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Vector index to trait: +0 - httpLabel +1 - idempotent +2 - idempotencyToken +3 - sensitive +4 - httpPayload +5 - httpResponseCode +6 - httpQueryParams

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The singular trait values are enumerated for quick identification, but +combination values are left to the number union type.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/types/_internal_.URI.html b/docs/types/_internal_.URI.html index 7a054200..3c1b0b1e 100644 --- a/docs/types/_internal_.URI.html +++ b/docs/types/_internal_.URI.html @@ -1,6 +1,6 @@ URI | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Alias URIInternal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Represents the components parts of a Uniform Resource Identifier used to construct the target location of a Request.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      type URI = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          fragment?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          hostname: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          password?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          path: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          port?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          protocol: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          query?: QueryParameterBag;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          username?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Implemented by

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      fragment? +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      type URI = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          fragment?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          hostname: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          password?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          path: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          port?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          protocol: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          query?: QueryParameterBag;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          username?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Implemented by

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      fragment? hostname password? path diff --git a/docs/types/_internal_.Unbind.html b/docs/types/_internal_.Unbind.html index 76779167..2f5bbdfc 100644 --- a/docs/types/_internal_.Unbind.html +++ b/docs/types/_internal_.Unbind.html @@ -1 +1 @@ -Unbind | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias Unbind

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Unbind: (identifier: BindingIdentifier | ServiceIdentifier) => Promise<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +Unbind | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Alias Unbind

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Unbind: (identifier: BindingIdentifier | ServiceIdentifier) => Promise<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/types/_internal_.UnbindSync.html b/docs/types/_internal_.UnbindSync.html index 9e91f480..60581144 100644 --- a/docs/types/_internal_.UnbindSync.html +++ b/docs/types/_internal_.UnbindSync.html @@ -1 +1 @@ -UnbindSync | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias UnbindSync

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            UnbindSync: (identifier: BindingIdentifier | ServiceIdentifier) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +UnbindSync | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Alias UnbindSync

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              UnbindSync: (identifier: BindingIdentifier | ServiceIdentifier) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/types/_internal_.UnitSchema.html b/docs/types/_internal_.UnitSchema.html new file mode 100644 index 00000000..03ddcc96 --- /dev/null +++ b/docs/types/_internal_.UnitSchema.html @@ -0,0 +1,3 @@ +UnitSchema | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Alias UnitSchema

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                UnitSchema: "unit"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Signal value for the Smithy void value. Typically used for +operation input and outputs.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/types/_internal_.UserAgent.html b/docs/types/_internal_.UserAgent.html index ee4f3dbc..a81917b5 100644 --- a/docs/types/_internal_.UserAgent.html +++ b/docs/types/_internal_.UserAgent.html @@ -1,3 +1,3 @@ UserAgent | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Alias UserAgent

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  UserAgent: UserAgentPair[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  User agent data that to be put into the request's user agent.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/types/_internal_.UserAgentPair.html b/docs/types/_internal_.UserAgentPair.html index 578b9ae8..c95e5707 100644 --- a/docs/types/_internal_.UserAgentPair.html +++ b/docs/types/_internal_.UserAgentPair.html @@ -1,3 +1,3 @@ UserAgentPair | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Alias UserAgentPair

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    UserAgentPair: [name: string, version?: string]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    A tuple that represents an API name and optional version of a library built using the AWS SDK.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/types/_internal_.UuidHeaderValue.html b/docs/types/_internal_.UuidHeaderValue.html index bbf61a67..68085986 100644 --- a/docs/types/_internal_.UuidHeaderValue.html +++ b/docs/types/_internal_.UuidHeaderValue.html @@ -1 +1 @@ -UuidHeaderValue | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Alias UuidHeaderValue

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      UuidHeaderValue: HeaderValue<"uuid", string>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +UuidHeaderValue | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias UuidHeaderValue

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        UuidHeaderValue: HeaderValue<"uuid", string>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/types/_internal_._AbortSignal.html b/docs/types/_internal_._AbortSignal.html new file mode 100644 index 00000000..46f2473f --- /dev/null +++ b/docs/types/_internal_._AbortSignal.html @@ -0,0 +1 @@ +_AbortSignal | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Alias _AbortSignal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          _AbortSignal: typeof globalThis extends { onmessage: any } ? {} : AbortSignal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/types/_internal_._Event.html b/docs/types/_internal_._Event.html new file mode 100644 index 00000000..22654c9c --- /dev/null +++ b/docs/types/_internal_._Event.html @@ -0,0 +1 @@ +_Event | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias _Event

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            _Event: typeof globalThis extends { onmessage: any } ? {} : Event

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Alias _EventListenerOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              _EventListenerOptions: typeof globalThis extends { onmessage: any }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ? {}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  : EventListenerOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/types/_internal_._EventTarget.html b/docs/types/_internal_._EventTarget.html new file mode 100644 index 00000000..7589ea3f --- /dev/null +++ b/docs/types/_internal_._EventTarget.html @@ -0,0 +1 @@ +_EventTarget | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Alias _EventTarget

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                _EventTarget: typeof globalThis extends { onmessage: any } ? {} : EventTarget

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/types/_internal_._Headers.html b/docs/types/_internal_._Headers.html index 76223d36..3ef42872 100644 --- a/docs/types/_internal_._Headers.html +++ b/docs/types/_internal_._Headers.html @@ -1 +1 @@ -_Headers | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Alias _Headers

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  _Headers: typeof globalThis extends { onmessage: any } ? {} : Headers

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +_Headers | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Alias _Headers

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    _Headers: typeof globalThis extends { onmessage: any } ? {} : Headers

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/types/_internal_._MemberSchema.html b/docs/types/_internal_._MemberSchema.html new file mode 100644 index 00000000..8a3d7bac --- /dev/null +++ b/docs/types/_internal_._MemberSchema.html @@ -0,0 +1,3 @@ +$MemberSchema | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Alias $MemberSchema

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      $MemberSchema: [$SchemaRef, SchemaTraits]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Indicates the schema is a member of a parent Structure schema. +It may also have a set of member traits distinct from its target shape's traits.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/types/_internal_._Schema.html b/docs/types/_internal_._Schema.html new file mode 100644 index 00000000..4544af71 --- /dev/null +++ b/docs/types/_internal_._Schema.html @@ -0,0 +1,2 @@ +$Schema | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias $Schema

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        $Schema:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | UnitSchema
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | SimpleSchema
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | $MemberSchema
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | StaticSchema
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | NormalizedSchema

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        A schema is an object or value that describes how to serialize/deserialize data.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/types/_internal_._SchemaRef.html b/docs/types/_internal_._SchemaRef.html new file mode 100644 index 00000000..f6f73591 --- /dev/null +++ b/docs/types/_internal_._SchemaRef.html @@ -0,0 +1,4 @@ +$SchemaRef | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Alias $SchemaRef

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          $SchemaRef: $Schema | (() => $Schema)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          A schema "reference" is either a schema or a function that +provides a schema. This is useful for lazy loading, and to allow +code generation to define schema out of dependency order.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/types/_internal_.__Event.html b/docs/types/_internal_.__Event.html deleted file mode 100644 index 7acc0cf3..00000000 --- a/docs/types/_internal_.__Event.html +++ /dev/null @@ -1 +0,0 @@ -__Event | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias __Event

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            __Event: typeof globalThis extends { onmessage: any } ? {} : Event

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/types/_internal_.__EventTarget.html b/docs/types/_internal_.__EventTarget.html deleted file mode 100644 index bd0ed129..00000000 --- a/docs/types/_internal_.__EventTarget.html +++ /dev/null @@ -1 +0,0 @@ -__EventTarget | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Alias __EventTarget

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              __EventTarget: typeof globalThis extends { onmessage: any } ? {} : EventTarget

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/variables/_internal_.AbortSignal.html b/docs/variables/_internal_.AbortSignal.html index f232eb96..77942bd6 100644 --- a/docs/variables/_internal_.AbortSignal.html +++ b/docs/variables/_internal_.AbortSignal.html @@ -1 +1 @@ -AbortSignal | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Variable AbortSignal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                AbortSignal: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    prototype: AbortSignal;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    abort(reason?: any): AbortSignal;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    any(signals: AbortSignal[]): AbortSignal;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    timeout(milliseconds: number): AbortSignal;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    new (): AbortSignal;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +AbortSignal | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Variable AbortSignal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  AbortSignal: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      prototype: AbortSignal;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      abort(reason?: any): AbortSignal;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      any(signals: AbortSignal[]): AbortSignal;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      timeout(milliseconds: number): AbortSignal;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      new (): AbortSignal;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/variables/_internal_.Event.html b/docs/variables/_internal_.Event.html index 65410ed9..65dff5d9 100644 --- a/docs/variables/_internal_.Event.html +++ b/docs/variables/_internal_.Event.html @@ -1 +1 @@ -Event | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Variable Event

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Event: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        prototype: Event;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        new (type: string, eventInitDict?: EventInit): Event;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +Event | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Variable Event

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Event: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          prototype: Event;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          new (type: string, eventInitDict?: EventInit): Event;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/variables/_internal_.EventTarget.html b/docs/variables/_internal_.EventTarget.html index e62fd3d8..e74c417a 100644 --- a/docs/variables/_internal_.EventTarget.html +++ b/docs/variables/_internal_.EventTarget.html @@ -1 +1 @@ -EventTarget | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Variable EventTarget

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        EventTarget: { prototype: EventTarget; new (): EventTarget }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +EventTarget | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Variable EventTarget

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          EventTarget: { prototype: EventTarget; new (): EventTarget }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/variables/_internal_.Headers.html b/docs/variables/_internal_.Headers.html index f0651641..f7551b9d 100644 --- a/docs/variables/_internal_.Headers.html +++ b/docs/variables/_internal_.Headers.html @@ -1 +1 @@ -Headers | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Variable Headers

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Headers: typeof Headers

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +Headers | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Variable Headers

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Headers: typeof Headers

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/variables/_internal_.Object.html b/docs/variables/_internal_.Object.html index 595c4a4b..b11a15e2 100644 --- a/docs/variables/_internal_.Object.html +++ b/docs/variables/_internal_.Object.html @@ -1,2 +1,2 @@ Object | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Variable Object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Object: ObjectConstructor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Provides functionality common to all JavaScript objects.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/variables/_internal_.ReadableByteStreamController.html b/docs/variables/_internal_.ReadableByteStreamController.html index 2331d726..26d74ca3 100644 --- a/docs/variables/_internal_.ReadableByteStreamController.html +++ b/docs/variables/_internal_.ReadableByteStreamController.html @@ -1 +1 @@ -ReadableByteStreamController | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Variable ReadableByteStreamController

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ReadableByteStreamController: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      prototype: ReadableByteStreamController;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      new (): ReadableByteStreamController;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +ReadableByteStreamController | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Variable ReadableByteStreamController

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ReadableByteStreamController: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        prototype: ReadableByteStreamController;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        new (): ReadableByteStreamController;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/variables/_internal_.ReadableStream.html b/docs/variables/_internal_.ReadableStream.html index e4549708..31f3a47b 100644 --- a/docs/variables/_internal_.ReadableStream.html +++ b/docs/variables/_internal_.ReadableStream.html @@ -1 +1 @@ -ReadableStream | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Variable ReadableStream

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ReadableStream: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          prototype: ReadableStream;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          from<T>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              iterable: Iterable<T, any, any> | AsyncIterable<T, any, any>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): ReadableStream<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          new (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              underlyingSource: UnderlyingByteSource,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              strategy?: QueuingStrategy<Uint8Array<ArrayBufferLike>>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): ReadableStream<Uint8Array<ArrayBufferLike>>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          new <R = any>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              underlyingSource?: UnderlyingSource<R>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              strategy?: QueuingStrategy<R>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): ReadableStream<R>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +ReadableStream | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Variable ReadableStream

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ReadableStream: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            prototype: ReadableStream;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            from<T>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                iterable: Iterable<T, any, any> | AsyncIterable<T, any, any>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ): ReadableStream<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            new (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                underlyingSource: UnderlyingByteSource,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                strategy?: QueuingStrategy<Uint8Array<ArrayBufferLike>>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ): ReadableStream<Uint8Array<ArrayBufferLike>>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            new <R = any>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                underlyingSource?: UnderlyingSource<R>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                strategy?: QueuingStrategy<R>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ): ReadableStream<R>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/variables/_internal_.ReadableStreamBYOBReader.html b/docs/variables/_internal_.ReadableStreamBYOBReader.html index 48da1fa9..73c75e77 100644 --- a/docs/variables/_internal_.ReadableStreamBYOBReader.html +++ b/docs/variables/_internal_.ReadableStreamBYOBReader.html @@ -1 +1 @@ -ReadableStreamBYOBReader | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Variable ReadableStreamBYOBReader

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ReadableStreamBYOBReader: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              prototype: ReadableStreamBYOBReader;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              new (stream: ReadableStream): ReadableStreamBYOBReader;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +ReadableStreamBYOBReader | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Variable ReadableStreamBYOBReader

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ReadableStreamBYOBReader: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                prototype: ReadableStreamBYOBReader;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                new (stream: ReadableStream): ReadableStreamBYOBReader;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/variables/_internal_.ReadableStreamDefaultController.html b/docs/variables/_internal_.ReadableStreamDefaultController.html index c9303f40..1b76496b 100644 --- a/docs/variables/_internal_.ReadableStreamDefaultController.html +++ b/docs/variables/_internal_.ReadableStreamDefaultController.html @@ -1 +1 @@ -ReadableStreamDefaultController | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Variable ReadableStreamDefaultController

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ReadableStreamDefaultController: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  prototype: ReadableStreamDefaultController;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  new (): ReadableStreamDefaultController;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +ReadableStreamDefaultController | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Variable ReadableStreamDefaultController

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ReadableStreamDefaultController: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    prototype: ReadableStreamDefaultController;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    new (): ReadableStreamDefaultController;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/variables/_internal_.ReadableStreamDefaultReader.html b/docs/variables/_internal_.ReadableStreamDefaultReader.html index 8b6f0460..94db037e 100644 --- a/docs/variables/_internal_.ReadableStreamDefaultReader.html +++ b/docs/variables/_internal_.ReadableStreamDefaultReader.html @@ -1 +1 @@ -ReadableStreamDefaultReader | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Variable ReadableStreamDefaultReader

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ReadableStreamDefaultReader: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      prototype: ReadableStreamDefaultReader;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      new <R = any>(stream: ReadableStream<R>): ReadableStreamDefaultReader<R>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +ReadableStreamDefaultReader | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Variable ReadableStreamDefaultReader

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ReadableStreamDefaultReader: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        prototype: ReadableStreamDefaultReader;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        new <R = any>(stream: ReadableStream<R>): ReadableStreamDefaultReader<R>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/variables/_internal_.RequestChecksumCalculation.html b/docs/variables/_internal_.RequestChecksumCalculation.html index 2639cb50..f394a9f9 100644 --- a/docs/variables/_internal_.RequestChecksumCalculation.html +++ b/docs/variables/_internal_.RequestChecksumCalculation.html @@ -1,10 +1,10 @@ RequestChecksumCalculation | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Variable RequestChecksumCalculationConst

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      RequestChecksumCalculation: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          WHEN_REQUIRED: "WHEN_REQUIRED";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          WHEN_SUPPORTED: "WHEN_SUPPORTED";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Determines when a checksum will be calculated for request payloads.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • ReadonlyWHEN_REQUIRED: "WHEN_REQUIRED"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        When set, a checksum will only be calculated for request payloads of operations +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • ReadonlyWHEN_REQUIRED: "WHEN_REQUIRED"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          When set, a checksum will only be calculated for request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true OR where a requestAlgorithmMember is modeled and the user sets it. httpChecksum

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • ReadonlyWHEN_SUPPORTED: "WHEN_SUPPORTED"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          When set, a checksum will be calculated for all request payloads of operations +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • ReadonlyWHEN_SUPPORTED: "WHEN_SUPPORTED"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          When set, a checksum will be calculated for all request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true AND/OR a requestAlgorithmMember is modeled. httpChecksum

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/variables/_internal_.ResponseChecksumValidation.html b/docs/variables/_internal_.ResponseChecksumValidation.html index b0c1b66d..3797d13a 100644 --- a/docs/variables/_internal_.ResponseChecksumValidation.html +++ b/docs/variables/_internal_.ResponseChecksumValidation.html @@ -1,10 +1,10 @@ ResponseChecksumValidation | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Variable ResponseChecksumValidationConst

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ResponseChecksumValidation: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            WHEN_REQUIRED: "WHEN_REQUIRED";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            WHEN_SUPPORTED: "WHEN_SUPPORTED";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Determines when checksum validation will be performed on response payloads.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • ReadonlyWHEN_REQUIRED: "WHEN_REQUIRED"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          When set, checksum validation MUST NOT be performed on response payloads of operations UNLESS +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • ReadonlyWHEN_REQUIRED: "WHEN_REQUIRED"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            When set, checksum validation MUST NOT be performed on response payloads of operations UNLESS the SDK supports the modeled checksum algorithms AND the user has set the requestValidationModeMember to ENABLED. It is currently impossible to model an operation as requiring a response checksum, but this setting leaves the door open for future updates.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • ReadonlyWHEN_SUPPORTED: "WHEN_SUPPORTED"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            When set, checksum validation MUST be performed on all response payloads of operations +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • ReadonlyWHEN_SUPPORTED: "WHEN_SUPPORTED"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            When set, checksum validation MUST be performed on all response payloads of operations modeled with the httpChecksum trait where responseAlgorithms is modeled, except when no modeled checksum algorithms are supported by an SDK. httpChecksum

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/variables/_internal_.URL.html b/docs/variables/_internal_.URL.html index bacc2d66..2971efd9 100644 --- a/docs/variables/_internal_.URL.html +++ b/docs/variables/_internal_.URL.html @@ -1 +1 @@ -URL | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Variable URL

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          URL: typeof URL

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +URL | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Variable URL

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            URL: typeof URL

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/variables/_internal_.WritableStream.html b/docs/variables/_internal_.WritableStream.html index 1e9f66aa..1006dae2 100644 --- a/docs/variables/_internal_.WritableStream.html +++ b/docs/variables/_internal_.WritableStream.html @@ -1 +1 @@ -WritableStream | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Variable WritableStream

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              WritableStream: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  prototype: WritableStream;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  new <W = any>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      underlyingSink?: UnderlyingSink<W>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      strategy?: QueuingStrategy<W>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ): WritableStream<W>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +WritableStream | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Variable WritableStream

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                WritableStream: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    prototype: WritableStream;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    new <W = any>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        underlyingSink?: UnderlyingSink<W>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        strategy?: QueuingStrategy<W>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): WritableStream<W>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/variables/_internal_.WritableStreamDefaultController.html b/docs/variables/_internal_.WritableStreamDefaultController.html index 6f8ad6bb..2458800e 100644 --- a/docs/variables/_internal_.WritableStreamDefaultController.html +++ b/docs/variables/_internal_.WritableStreamDefaultController.html @@ -1 +1 @@ -WritableStreamDefaultController | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Variable WritableStreamDefaultController

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  WritableStreamDefaultController: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      prototype: WritableStreamDefaultController;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      new (): WritableStreamDefaultController;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +WritableStreamDefaultController | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Variable WritableStreamDefaultController

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    WritableStreamDefaultController: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        prototype: WritableStreamDefaultController;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        new (): WritableStreamDefaultController;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/variables/_internal_.WritableStreamDefaultWriter.html b/docs/variables/_internal_.WritableStreamDefaultWriter.html index a56cd28a..5dfea762 100644 --- a/docs/variables/_internal_.WritableStreamDefaultWriter.html +++ b/docs/variables/_internal_.WritableStreamDefaultWriter.html @@ -1 +1 @@ -WritableStreamDefaultWriter | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Variable WritableStreamDefaultWriter

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      WritableStreamDefaultWriter: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          prototype: WritableStreamDefaultWriter;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          new <W = any>(stream: WritableStream<W>): WritableStreamDefaultWriter<W>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +WritableStreamDefaultWriter | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Variable WritableStreamDefaultWriter

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        WritableStreamDefaultWriter: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            prototype: WritableStreamDefaultWriter;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            new <W = any>(stream: WritableStream<W>): WritableStreamDefaultWriter<W>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/variables/_internal_.tagsByName.html b/docs/variables/_internal_.tagsByName.html index 05545f04..4fd274d8 100644 --- a/docs/variables/_internal_.tagsByName.html +++ b/docs/variables/_internal_.tagsByName.html @@ -1 +1 @@ -tagsByName | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Variable tagsByNameConst

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          tagsByName: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              binary: ScalarTag;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              bool: ScalarTag & { test: RegExp };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              float: ScalarTag;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              floatExp: ScalarTag;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              floatNaN: ScalarTag;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              floatTime: ScalarTag;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              int: ScalarTag;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              intHex: ScalarTag;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              intOct: ScalarTag;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              intTime: ScalarTag;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              map: CollectionTag;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              merge: ScalarTag & { test: RegExp; identify(value: unknown): boolean };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              null: ScalarTag & { test: RegExp };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              omap: CollectionTag;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              pairs: CollectionTag;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              seq: CollectionTag;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              set: CollectionTag;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              timestamp: ScalarTag & { test: RegExp };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +tagsByName | ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Variable tagsByNameConst

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            tagsByName: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                binary: ScalarTag;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                bool: ScalarTag & { test: RegExp };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                float: ScalarTag;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                floatExp: ScalarTag;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                floatNaN: ScalarTag;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                floatTime: ScalarTag;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                int: ScalarTag;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                intHex: ScalarTag;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                intOct: ScalarTag;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                intTime: ScalarTag;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                map: CollectionTag;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                merge: ScalarTag & { test: RegExp; identify(value: unknown): boolean };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                null: ScalarTag & { test: RegExp };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                omap: CollectionTag;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                pairs: CollectionTag;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                seq: CollectionTag;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                set: CollectionTag;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                timestamp: ScalarTag & { test: RegExp };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            diff --git a/package.json b/package.json index d9818f7f..8aa256cd 100644 --- a/package.json +++ b/package.json @@ -46,6 +46,7 @@ "marky": "~1.2.5", "openapi3-ts": "^4.5.0", "reflect-metadata": "^0.2.2", + "semver": "^7.5.2", "sprintf-js": "^1.1.3" }, "devDependencies": { @@ -81,5 +82,6 @@ "resolutions": { "trim": "^1.0.1", "semver": "^7.5.2" - } + }, + "packageManager": "yarn@1.22.22" } diff --git a/yarn.lock b/yarn.lock index f570ad6a..715bdb84 100644 --- a/yarn.lock +++ b/yarn.lock @@ -2,14 +2,6 @@ # yarn lockfile v1 -"@ampproject/remapping@^2.2.0": - version "2.3.0" - resolved "https://registry.yarnpkg.com/@ampproject/remapping/-/remapping-2.3.0.tgz#ed441b6fa600072520ce18b43d2c8cc8caecc7f4" - integrity sha512-30iZtAPgz+LTIYoeivqYo853f02jBYSd5uGnGpkFV0M3xOt9aN73erkgYAmZU43x4VfqcnLxW9Kpg3R5LC4YYw== - dependencies: - "@jridgewell/gen-mapping" "^0.3.5" - "@jridgewell/trace-mapping" "^0.3.24" - "@aws-crypto/crc32@5.2.0": version "5.2.0" resolved "https://registry.yarnpkg.com/@aws-crypto/crc32/-/crc32-5.2.0.tgz#cfcc22570949c98c6689cfcbd2d693d36cdae2e1" @@ -79,525 +71,542 @@ tslib "^2.6.2" "@aws-sdk/client-s3@^3.858.0": - version "3.858.0" - resolved "https://registry.yarnpkg.com/@aws-sdk/client-s3/-/client-s3-3.858.0.tgz#7513955fc4a172aa5662d8e98dab3e07dbfd0064" - integrity sha512-4BFXHxDyeFgeOgop1hqhf0Xjwi8ryD48W/+MY0Yf1sl5kejVcUjHlsTWi1yjF0d0B88asgU4c40IAnLKIGtzbg== + version "3.943.0" + resolved "https://registry.yarnpkg.com/@aws-sdk/client-s3/-/client-s3-3.943.0.tgz#8681e5eddc4b3f229718c898a5d22207d53ff94c" + integrity sha512-UOX8/1mmNaRmEkxoIVP2+gxd5joPJqz+fygRqlIXON1cETLGoctinMwQs7qU8g8hghm76TU2G6ZV6sLH8cySMw== dependencies: "@aws-crypto/sha1-browser" "5.2.0" "@aws-crypto/sha256-browser" "5.2.0" "@aws-crypto/sha256-js" "5.2.0" - "@aws-sdk/core" "3.858.0" - "@aws-sdk/credential-provider-node" "3.858.0" - "@aws-sdk/middleware-bucket-endpoint" "3.840.0" - "@aws-sdk/middleware-expect-continue" "3.840.0" - "@aws-sdk/middleware-flexible-checksums" "3.858.0" - "@aws-sdk/middleware-host-header" "3.840.0" - "@aws-sdk/middleware-location-constraint" "3.840.0" - "@aws-sdk/middleware-logger" "3.840.0" - "@aws-sdk/middleware-recursion-detection" "3.840.0" - "@aws-sdk/middleware-sdk-s3" "3.858.0" - "@aws-sdk/middleware-ssec" "3.840.0" - "@aws-sdk/middleware-user-agent" "3.858.0" - "@aws-sdk/region-config-resolver" "3.840.0" - "@aws-sdk/signature-v4-multi-region" "3.858.0" - "@aws-sdk/types" "3.840.0" - "@aws-sdk/util-endpoints" "3.848.0" - "@aws-sdk/util-user-agent-browser" "3.840.0" - "@aws-sdk/util-user-agent-node" "3.858.0" - "@aws-sdk/xml-builder" "3.821.0" - "@smithy/config-resolver" "^4.1.4" - "@smithy/core" "^3.7.2" - "@smithy/eventstream-serde-browser" "^4.0.4" - "@smithy/eventstream-serde-config-resolver" "^4.1.2" - "@smithy/eventstream-serde-node" "^4.0.4" - "@smithy/fetch-http-handler" "^5.1.0" - "@smithy/hash-blob-browser" "^4.0.4" - "@smithy/hash-node" "^4.0.4" - "@smithy/hash-stream-node" "^4.0.4" - "@smithy/invalid-dependency" "^4.0.4" - "@smithy/md5-js" "^4.0.4" - "@smithy/middleware-content-length" "^4.0.4" - "@smithy/middleware-endpoint" "^4.1.17" - "@smithy/middleware-retry" "^4.1.18" - "@smithy/middleware-serde" "^4.0.8" - "@smithy/middleware-stack" "^4.0.4" - "@smithy/node-config-provider" "^4.1.3" - "@smithy/node-http-handler" "^4.1.0" - "@smithy/protocol-http" "^5.1.2" - "@smithy/smithy-client" "^4.4.9" - "@smithy/types" "^4.3.1" - "@smithy/url-parser" "^4.0.4" - "@smithy/util-base64" "^4.0.0" - "@smithy/util-body-length-browser" "^4.0.0" - "@smithy/util-body-length-node" "^4.0.0" - "@smithy/util-defaults-mode-browser" "^4.0.25" - "@smithy/util-defaults-mode-node" "^4.0.25" - "@smithy/util-endpoints" "^3.0.6" - "@smithy/util-middleware" "^4.0.4" - "@smithy/util-retry" "^4.0.6" - "@smithy/util-stream" "^4.2.3" - "@smithy/util-utf8" "^4.0.0" - "@smithy/util-waiter" "^4.0.6" - "@types/uuid" "^9.0.1" + "@aws-sdk/core" "3.943.0" + "@aws-sdk/credential-provider-node" "3.943.0" + "@aws-sdk/middleware-bucket-endpoint" "3.936.0" + "@aws-sdk/middleware-expect-continue" "3.936.0" + "@aws-sdk/middleware-flexible-checksums" "3.943.0" + "@aws-sdk/middleware-host-header" "3.936.0" + "@aws-sdk/middleware-location-constraint" "3.936.0" + "@aws-sdk/middleware-logger" "3.936.0" + "@aws-sdk/middleware-recursion-detection" "3.936.0" + "@aws-sdk/middleware-sdk-s3" "3.943.0" + "@aws-sdk/middleware-ssec" "3.936.0" + "@aws-sdk/middleware-user-agent" "3.943.0" + "@aws-sdk/region-config-resolver" "3.936.0" + "@aws-sdk/signature-v4-multi-region" "3.943.0" + "@aws-sdk/types" "3.936.0" + "@aws-sdk/util-endpoints" "3.936.0" + "@aws-sdk/util-user-agent-browser" "3.936.0" + "@aws-sdk/util-user-agent-node" "3.943.0" + "@smithy/config-resolver" "^4.4.3" + "@smithy/core" "^3.18.5" + "@smithy/eventstream-serde-browser" "^4.2.5" + "@smithy/eventstream-serde-config-resolver" "^4.3.5" + "@smithy/eventstream-serde-node" "^4.2.5" + "@smithy/fetch-http-handler" "^5.3.6" + "@smithy/hash-blob-browser" "^4.2.6" + "@smithy/hash-node" "^4.2.5" + "@smithy/hash-stream-node" "^4.2.5" + "@smithy/invalid-dependency" "^4.2.5" + "@smithy/md5-js" "^4.2.5" + "@smithy/middleware-content-length" "^4.2.5" + "@smithy/middleware-endpoint" "^4.3.12" + "@smithy/middleware-retry" "^4.4.12" + "@smithy/middleware-serde" "^4.2.6" + "@smithy/middleware-stack" "^4.2.5" + "@smithy/node-config-provider" "^4.3.5" + "@smithy/node-http-handler" "^4.4.5" + "@smithy/protocol-http" "^5.3.5" + "@smithy/smithy-client" "^4.9.8" + "@smithy/types" "^4.9.0" + "@smithy/url-parser" "^4.2.5" + "@smithy/util-base64" "^4.3.0" + "@smithy/util-body-length-browser" "^4.2.0" + "@smithy/util-body-length-node" "^4.2.1" + "@smithy/util-defaults-mode-browser" "^4.3.11" + "@smithy/util-defaults-mode-node" "^4.2.14" + "@smithy/util-endpoints" "^3.2.5" + "@smithy/util-middleware" "^4.2.5" + "@smithy/util-retry" "^4.2.5" + "@smithy/util-stream" "^4.5.6" + "@smithy/util-utf8" "^4.2.0" + "@smithy/util-waiter" "^4.2.5" tslib "^2.6.2" - uuid "^9.0.1" -"@aws-sdk/client-sso@3.858.0": - version "3.858.0" - resolved "https://registry.yarnpkg.com/@aws-sdk/client-sso/-/client-sso-3.858.0.tgz#cae074f8bc3cfe276320f54e66ad735cc1551408" - integrity sha512-iXuZQs4KH6a3Pwnt0uORalzAZ5EXRPr3lBYAsdNwkP8OYyoUz5/TE3BLyw7ceEh0rj4QKGNnNALYo1cDm0EV8w== +"@aws-sdk/client-sso@3.943.0": + version "3.943.0" + resolved "https://registry.yarnpkg.com/@aws-sdk/client-sso/-/client-sso-3.943.0.tgz#0ed7c0d6c1df537ed21ec882b2db162405541c9f" + integrity sha512-kOTO2B8Ks2qX73CyKY8PAajtf5n39aMe2spoiOF5EkgSzGV7hZ/HONRDyADlyxwfsX39Q2F2SpPUaXzon32IGw== dependencies: "@aws-crypto/sha256-browser" "5.2.0" "@aws-crypto/sha256-js" "5.2.0" - "@aws-sdk/core" "3.858.0" - "@aws-sdk/middleware-host-header" "3.840.0" - "@aws-sdk/middleware-logger" "3.840.0" - "@aws-sdk/middleware-recursion-detection" "3.840.0" - "@aws-sdk/middleware-user-agent" "3.858.0" - "@aws-sdk/region-config-resolver" "3.840.0" - "@aws-sdk/types" "3.840.0" - "@aws-sdk/util-endpoints" "3.848.0" - "@aws-sdk/util-user-agent-browser" "3.840.0" - "@aws-sdk/util-user-agent-node" "3.858.0" - "@smithy/config-resolver" "^4.1.4" - "@smithy/core" "^3.7.2" - "@smithy/fetch-http-handler" "^5.1.0" - "@smithy/hash-node" "^4.0.4" - "@smithy/invalid-dependency" "^4.0.4" - "@smithy/middleware-content-length" "^4.0.4" - "@smithy/middleware-endpoint" "^4.1.17" - "@smithy/middleware-retry" "^4.1.18" - "@smithy/middleware-serde" "^4.0.8" - "@smithy/middleware-stack" "^4.0.4" - "@smithy/node-config-provider" "^4.1.3" - "@smithy/node-http-handler" "^4.1.0" - "@smithy/protocol-http" "^5.1.2" - "@smithy/smithy-client" "^4.4.9" - "@smithy/types" "^4.3.1" - "@smithy/url-parser" "^4.0.4" - "@smithy/util-base64" "^4.0.0" - "@smithy/util-body-length-browser" "^4.0.0" - "@smithy/util-body-length-node" "^4.0.0" - "@smithy/util-defaults-mode-browser" "^4.0.25" - "@smithy/util-defaults-mode-node" "^4.0.25" - "@smithy/util-endpoints" "^3.0.6" - "@smithy/util-middleware" "^4.0.4" - "@smithy/util-retry" "^4.0.6" - "@smithy/util-utf8" "^4.0.0" + "@aws-sdk/core" "3.943.0" + "@aws-sdk/middleware-host-header" "3.936.0" + "@aws-sdk/middleware-logger" "3.936.0" + "@aws-sdk/middleware-recursion-detection" "3.936.0" + "@aws-sdk/middleware-user-agent" "3.943.0" + "@aws-sdk/region-config-resolver" "3.936.0" + "@aws-sdk/types" "3.936.0" + "@aws-sdk/util-endpoints" "3.936.0" + "@aws-sdk/util-user-agent-browser" "3.936.0" + "@aws-sdk/util-user-agent-node" "3.943.0" + "@smithy/config-resolver" "^4.4.3" + "@smithy/core" "^3.18.5" + "@smithy/fetch-http-handler" "^5.3.6" + "@smithy/hash-node" "^4.2.5" + "@smithy/invalid-dependency" "^4.2.5" + "@smithy/middleware-content-length" "^4.2.5" + "@smithy/middleware-endpoint" "^4.3.12" + "@smithy/middleware-retry" "^4.4.12" + "@smithy/middleware-serde" "^4.2.6" + "@smithy/middleware-stack" "^4.2.5" + "@smithy/node-config-provider" "^4.3.5" + "@smithy/node-http-handler" "^4.4.5" + "@smithy/protocol-http" "^5.3.5" + "@smithy/smithy-client" "^4.9.8" + "@smithy/types" "^4.9.0" + "@smithy/url-parser" "^4.2.5" + "@smithy/util-base64" "^4.3.0" + "@smithy/util-body-length-browser" "^4.2.0" + "@smithy/util-body-length-node" "^4.2.1" + "@smithy/util-defaults-mode-browser" "^4.3.11" + "@smithy/util-defaults-mode-node" "^4.2.14" + "@smithy/util-endpoints" "^3.2.5" + "@smithy/util-middleware" "^4.2.5" + "@smithy/util-retry" "^4.2.5" + "@smithy/util-utf8" "^4.2.0" tslib "^2.6.2" -"@aws-sdk/core@3.858.0": - version "3.858.0" - resolved "https://registry.yarnpkg.com/@aws-sdk/core/-/core-3.858.0.tgz#27f7bc3e556bfeb31cbb767fd59377dabaea3d9e" - integrity sha512-iWm4QLAS+/XMlnecIU1Y33qbBr1Ju+pmWam3xVCPlY4CSptKpVY+2hXOnmg9SbHAX9C005fWhrIn51oDd00c9A== - dependencies: - "@aws-sdk/types" "3.840.0" - "@aws-sdk/xml-builder" "3.821.0" - "@smithy/core" "^3.7.2" - "@smithy/node-config-provider" "^4.1.3" - "@smithy/property-provider" "^4.0.4" - "@smithy/protocol-http" "^5.1.2" - "@smithy/signature-v4" "^5.1.2" - "@smithy/smithy-client" "^4.4.9" - "@smithy/types" "^4.3.1" - "@smithy/util-base64" "^4.0.0" - "@smithy/util-body-length-browser" "^4.0.0" - "@smithy/util-middleware" "^4.0.4" - "@smithy/util-utf8" "^4.0.0" - fast-xml-parser "5.2.5" +"@aws-sdk/core@3.943.0": + version "3.943.0" + resolved "https://registry.yarnpkg.com/@aws-sdk/core/-/core-3.943.0.tgz#a0c3c20d5c3bbcfd3dd32f74f9620097b9734573" + integrity sha512-8CBy2hI9ABF7RBVQuY1bgf/ue+WPmM/hl0adrXFlhnhkaQP0tFY5zhiy1Y+n7V+5f3/ORoHBmCCQmcHDDYJqJQ== + dependencies: + "@aws-sdk/types" "3.936.0" + "@aws-sdk/xml-builder" "3.930.0" + "@smithy/core" "^3.18.5" + "@smithy/node-config-provider" "^4.3.5" + "@smithy/property-provider" "^4.2.5" + "@smithy/protocol-http" "^5.3.5" + "@smithy/signature-v4" "^5.3.5" + "@smithy/smithy-client" "^4.9.8" + "@smithy/types" "^4.9.0" + "@smithy/util-base64" "^4.3.0" + "@smithy/util-middleware" "^4.2.5" + "@smithy/util-utf8" "^4.2.0" tslib "^2.6.2" -"@aws-sdk/credential-provider-env@3.858.0": - version "3.858.0" - resolved "https://registry.yarnpkg.com/@aws-sdk/credential-provider-env/-/credential-provider-env-3.858.0.tgz#6dd149bbf7334be11fafdce4cd238db9c32cb6cd" - integrity sha512-kZsGyh2BoSRguzlcGtzdLhw/l/n3KYAC+/l/H0SlsOq3RLHF6tO/cRdsLnwoix2bObChHUp03cex63o1gzdx/Q== +"@aws-sdk/credential-provider-env@3.943.0": + version "3.943.0" + resolved "https://registry.yarnpkg.com/@aws-sdk/credential-provider-env/-/credential-provider-env-3.943.0.tgz#eb2bf3a50df3f25ca125a953c450319a8b23aa45" + integrity sha512-WnS5w9fK9CTuoZRVSIHLOMcI63oODg9qd1vXMYb7QGLGlfwUm4aG3hdu7i9XvYrpkQfE3dzwWLtXF4ZBuL1Tew== dependencies: - "@aws-sdk/core" "3.858.0" - "@aws-sdk/types" "3.840.0" - "@smithy/property-provider" "^4.0.4" - "@smithy/types" "^4.3.1" + "@aws-sdk/core" "3.943.0" + "@aws-sdk/types" "3.936.0" + "@smithy/property-provider" "^4.2.5" + "@smithy/types" "^4.9.0" + tslib "^2.6.2" + +"@aws-sdk/credential-provider-http@3.943.0": + version "3.943.0" + resolved "https://registry.yarnpkg.com/@aws-sdk/credential-provider-http/-/credential-provider-http-3.943.0.tgz#7d5b549a93145785b0d8f78c40fd5198e2e19e5b" + integrity sha512-SA8bUcYDEACdhnhLpZNnWusBpdmj4Vl67Vxp3Zke7SvoWSYbuxa+tiDiC+c92Z4Yq6xNOuLPW912ZPb9/NsSkA== + dependencies: + "@aws-sdk/core" "3.943.0" + "@aws-sdk/types" "3.936.0" + "@smithy/fetch-http-handler" "^5.3.6" + "@smithy/node-http-handler" "^4.4.5" + "@smithy/property-provider" "^4.2.5" + "@smithy/protocol-http" "^5.3.5" + "@smithy/smithy-client" "^4.9.8" + "@smithy/types" "^4.9.0" + "@smithy/util-stream" "^4.5.6" tslib "^2.6.2" -"@aws-sdk/credential-provider-http@3.858.0": - version "3.858.0" - resolved "https://registry.yarnpkg.com/@aws-sdk/credential-provider-http/-/credential-provider-http-3.858.0.tgz#b384babaa45814a9f8aff29d88185ef592deabac" - integrity sha512-GDnfYl3+NPJQ7WQQYOXEA489B212NinpcIDD7rpsB6IWUPo8yDjT5NceK4uUkIR3MFpNCGt9zd/z6NNLdB2fuQ== - dependencies: - "@aws-sdk/core" "3.858.0" - "@aws-sdk/types" "3.840.0" - "@smithy/fetch-http-handler" "^5.1.0" - "@smithy/node-http-handler" "^4.1.0" - "@smithy/property-provider" "^4.0.4" - "@smithy/protocol-http" "^5.1.2" - "@smithy/smithy-client" "^4.4.9" - "@smithy/types" "^4.3.1" - "@smithy/util-stream" "^4.2.3" +"@aws-sdk/credential-provider-ini@3.943.0": + version "3.943.0" + resolved "https://registry.yarnpkg.com/@aws-sdk/credential-provider-ini/-/credential-provider-ini-3.943.0.tgz#e03a5cfca5b822b6cc2ec36168801969c25b3b41" + integrity sha512-BcLDb8l4oVW+NkuqXMlO7TnM6lBOWW318ylf4FRED/ply5eaGxkQYqdGvHSqGSN5Rb3vr5Ek0xpzSjeYD7C8Kw== + dependencies: + "@aws-sdk/core" "3.943.0" + "@aws-sdk/credential-provider-env" "3.943.0" + "@aws-sdk/credential-provider-http" "3.943.0" + "@aws-sdk/credential-provider-login" "3.943.0" + "@aws-sdk/credential-provider-process" "3.943.0" + "@aws-sdk/credential-provider-sso" "3.943.0" + "@aws-sdk/credential-provider-web-identity" "3.943.0" + "@aws-sdk/nested-clients" "3.943.0" + "@aws-sdk/types" "3.936.0" + "@smithy/credential-provider-imds" "^4.2.5" + "@smithy/property-provider" "^4.2.5" + "@smithy/shared-ini-file-loader" "^4.4.0" + "@smithy/types" "^4.9.0" tslib "^2.6.2" -"@aws-sdk/credential-provider-ini@3.858.0": - version "3.858.0" - resolved "https://registry.yarnpkg.com/@aws-sdk/credential-provider-ini/-/credential-provider-ini-3.858.0.tgz#b20a2022f2ff466b0d85bb3defd186b518c103ac" - integrity sha512-2ZoVJW2Gg4LjpyZPvzOV+EOJgjuaVN/+mvAxAU6JU5OJJUzqNuW1Mi7VXFdZHcF6weXoKHfzYZVR0uuVapu1lQ== - dependencies: - "@aws-sdk/core" "3.858.0" - "@aws-sdk/credential-provider-env" "3.858.0" - "@aws-sdk/credential-provider-http" "3.858.0" - "@aws-sdk/credential-provider-process" "3.858.0" - "@aws-sdk/credential-provider-sso" "3.858.0" - "@aws-sdk/credential-provider-web-identity" "3.858.0" - "@aws-sdk/nested-clients" "3.858.0" - "@aws-sdk/types" "3.840.0" - "@smithy/credential-provider-imds" "^4.0.6" - "@smithy/property-provider" "^4.0.4" - "@smithy/shared-ini-file-loader" "^4.0.4" - "@smithy/types" "^4.3.1" +"@aws-sdk/credential-provider-login@3.943.0": + version "3.943.0" + resolved "https://registry.yarnpkg.com/@aws-sdk/credential-provider-login/-/credential-provider-login-3.943.0.tgz#4813bebb468bc762f73501026edd4bb37c999d5f" + integrity sha512-9iCOVkiRW+evxiJE94RqosCwRrzptAVPhRhGWv4osfYDhjNAvUMyrnZl3T1bjqCoKNcETRKEZIU3dqYHnUkcwQ== + dependencies: + "@aws-sdk/core" "3.943.0" + "@aws-sdk/nested-clients" "3.943.0" + "@aws-sdk/types" "3.936.0" + "@smithy/property-provider" "^4.2.5" + "@smithy/protocol-http" "^5.3.5" + "@smithy/shared-ini-file-loader" "^4.4.0" + "@smithy/types" "^4.9.0" tslib "^2.6.2" -"@aws-sdk/credential-provider-node@3.858.0": - version "3.858.0" - resolved "https://registry.yarnpkg.com/@aws-sdk/credential-provider-node/-/credential-provider-node-3.858.0.tgz#24b4e41ca36a97e22dfab99b77f83c38a6eec4e4" - integrity sha512-clHADxFnMH3R3+7E1bKWEWgoHmLMep2VlmUFDYV4Hw17JR563RRQpzlF2QRCTjSNUjH48dd6AVxEDfh7461X6Q== - dependencies: - "@aws-sdk/credential-provider-env" "3.858.0" - "@aws-sdk/credential-provider-http" "3.858.0" - "@aws-sdk/credential-provider-ini" "3.858.0" - "@aws-sdk/credential-provider-process" "3.858.0" - "@aws-sdk/credential-provider-sso" "3.858.0" - "@aws-sdk/credential-provider-web-identity" "3.858.0" - "@aws-sdk/types" "3.840.0" - "@smithy/credential-provider-imds" "^4.0.6" - "@smithy/property-provider" "^4.0.4" - "@smithy/shared-ini-file-loader" "^4.0.4" - "@smithy/types" "^4.3.1" +"@aws-sdk/credential-provider-node@3.943.0": + version "3.943.0" + resolved "https://registry.yarnpkg.com/@aws-sdk/credential-provider-node/-/credential-provider-node-3.943.0.tgz#3d67bc92153efbc210d66acc63de7ac25b7632c3" + integrity sha512-14eddaH/gjCWoLSAELVrFOQNyswUYwWphIt+PdsJ/FqVfP4ay2HsiZVEIYbQtmrKHaoLJhiZKwBQRjcqJDZG0w== + dependencies: + "@aws-sdk/credential-provider-env" "3.943.0" + "@aws-sdk/credential-provider-http" "3.943.0" + "@aws-sdk/credential-provider-ini" "3.943.0" + "@aws-sdk/credential-provider-process" "3.943.0" + "@aws-sdk/credential-provider-sso" "3.943.0" + "@aws-sdk/credential-provider-web-identity" "3.943.0" + "@aws-sdk/types" "3.936.0" + "@smithy/credential-provider-imds" "^4.2.5" + "@smithy/property-provider" "^4.2.5" + "@smithy/shared-ini-file-loader" "^4.4.0" + "@smithy/types" "^4.9.0" tslib "^2.6.2" -"@aws-sdk/credential-provider-process@3.858.0": - version "3.858.0" - resolved "https://registry.yarnpkg.com/@aws-sdk/credential-provider-process/-/credential-provider-process-3.858.0.tgz#80583aa76d04643e9ed5c6cb47aab1fc81138dd8" - integrity sha512-l5LJWZJMRaZ+LhDjtupFUKEC5hAjgvCRrOvV5T60NCUBOy0Ozxa7Sgx3x+EOwiruuoh3Cn9O+RlbQlJX6IfZIw== +"@aws-sdk/credential-provider-process@3.943.0": + version "3.943.0" + resolved "https://registry.yarnpkg.com/@aws-sdk/credential-provider-process/-/credential-provider-process-3.943.0.tgz#d289d73ee31471a5a0b5ca2c908983b3a1866be1" + integrity sha512-GIY/vUkthL33AdjOJ8r9vOosKf/3X+X7LIiACzGxvZZrtoOiRq0LADppdiKIB48vTL63VvW+eRIOFAxE6UDekw== dependencies: - "@aws-sdk/core" "3.858.0" - "@aws-sdk/types" "3.840.0" - "@smithy/property-provider" "^4.0.4" - "@smithy/shared-ini-file-loader" "^4.0.4" - "@smithy/types" "^4.3.1" + "@aws-sdk/core" "3.943.0" + "@aws-sdk/types" "3.936.0" + "@smithy/property-provider" "^4.2.5" + "@smithy/shared-ini-file-loader" "^4.4.0" + "@smithy/types" "^4.9.0" tslib "^2.6.2" -"@aws-sdk/credential-provider-sso@3.858.0": - version "3.858.0" - resolved "https://registry.yarnpkg.com/@aws-sdk/credential-provider-sso/-/credential-provider-sso-3.858.0.tgz#49e6ece2d0f0631bb822bccc0b6e6d69349abdd7" - integrity sha512-YPAsEm4dUPCYO5nC/lv6fPhiihm70rh2Zdg/gmjOiD/7TIR+OT622bW+E1qBJ9s+dzOdAmutGSCmVbxp8gTM5Q== - dependencies: - "@aws-sdk/client-sso" "3.858.0" - "@aws-sdk/core" "3.858.0" - "@aws-sdk/token-providers" "3.858.0" - "@aws-sdk/types" "3.840.0" - "@smithy/property-provider" "^4.0.4" - "@smithy/shared-ini-file-loader" "^4.0.4" - "@smithy/types" "^4.3.1" +"@aws-sdk/credential-provider-sso@3.943.0": + version "3.943.0" + resolved "https://registry.yarnpkg.com/@aws-sdk/credential-provider-sso/-/credential-provider-sso-3.943.0.tgz#39ca467b492e731a81e52c43462bb4a00df72861" + integrity sha512-1c5G11syUrru3D9OO6Uk+ul5e2lX1adb+7zQNyluNaLPXP6Dina6Sy6DFGRLu7tM8+M7luYmbS3w63rpYpaL+A== + dependencies: + "@aws-sdk/client-sso" "3.943.0" + "@aws-sdk/core" "3.943.0" + "@aws-sdk/token-providers" "3.943.0" + "@aws-sdk/types" "3.936.0" + "@smithy/property-provider" "^4.2.5" + "@smithy/shared-ini-file-loader" "^4.4.0" + "@smithy/types" "^4.9.0" tslib "^2.6.2" -"@aws-sdk/credential-provider-web-identity@3.858.0": - version "3.858.0" - resolved "https://registry.yarnpkg.com/@aws-sdk/credential-provider-web-identity/-/credential-provider-web-identity-3.858.0.tgz#9fc99ef87fa0a39f6a87c95c2134b799fc4e54c9" - integrity sha512-8iULWsH83iZDdUuiDsRb83M0NqIlXjlDbJUIddVsIrfWp4NmanKw77SV6yOZ66nuJjPsn9j7RDb9bfEPCy5SWA== - dependencies: - "@aws-sdk/core" "3.858.0" - "@aws-sdk/nested-clients" "3.858.0" - "@aws-sdk/types" "3.840.0" - "@smithy/property-provider" "^4.0.4" - "@smithy/types" "^4.3.1" +"@aws-sdk/credential-provider-web-identity@3.943.0": + version "3.943.0" + resolved "https://registry.yarnpkg.com/@aws-sdk/credential-provider-web-identity/-/credential-provider-web-identity-3.943.0.tgz#2b4ec3a6580bb34c55707f567c63b2e1477569e4" + integrity sha512-VtyGKHxICSb4kKGuaqotxso8JVM8RjCS3UYdIMOxUt9TaFE/CZIfZKtjTr+IJ7M0P7t36wuSUb/jRLyNmGzUUA== + dependencies: + "@aws-sdk/core" "3.943.0" + "@aws-sdk/nested-clients" "3.943.0" + "@aws-sdk/types" "3.936.0" + "@smithy/property-provider" "^4.2.5" + "@smithy/shared-ini-file-loader" "^4.4.0" + "@smithy/types" "^4.9.0" tslib "^2.6.2" -"@aws-sdk/middleware-bucket-endpoint@3.840.0": - version "3.840.0" - resolved "https://registry.yarnpkg.com/@aws-sdk/middleware-bucket-endpoint/-/middleware-bucket-endpoint-3.840.0.tgz#ab414010b0230d9489c81dea38ab21feb1b18929" - integrity sha512-+gkQNtPwcSMmlwBHFd4saVVS11In6ID1HczNzpM3MXKXRBfSlbZJbCt6wN//AZ8HMklZEik4tcEOG0qa9UY8SQ== - dependencies: - "@aws-sdk/types" "3.840.0" - "@aws-sdk/util-arn-parser" "3.804.0" - "@smithy/node-config-provider" "^4.1.3" - "@smithy/protocol-http" "^5.1.2" - "@smithy/types" "^4.3.1" - "@smithy/util-config-provider" "^4.0.0" +"@aws-sdk/middleware-bucket-endpoint@3.936.0": + version "3.936.0" + resolved "https://registry.yarnpkg.com/@aws-sdk/middleware-bucket-endpoint/-/middleware-bucket-endpoint-3.936.0.tgz#3c2d9935a2a388fb74f8318d620e2da38d360970" + integrity sha512-XLSVVfAorUxZh6dzF+HTOp4R1B5EQcdpGcPliWr0KUj2jukgjZEcqbBmjyMF/p9bmyQsONX80iURF1HLAlW0qg== + dependencies: + "@aws-sdk/types" "3.936.0" + "@aws-sdk/util-arn-parser" "3.893.0" + "@smithy/node-config-provider" "^4.3.5" + "@smithy/protocol-http" "^5.3.5" + "@smithy/types" "^4.9.0" + "@smithy/util-config-provider" "^4.2.0" tslib "^2.6.2" -"@aws-sdk/middleware-expect-continue@3.840.0": - version "3.840.0" - resolved "https://registry.yarnpkg.com/@aws-sdk/middleware-expect-continue/-/middleware-expect-continue-3.840.0.tgz#1d77857dd03a3cc47e949eadcd425bcb53ebdd60" - integrity sha512-iJg2r6FKsKKvdiU4oCOuCf7Ro/YE0Q2BT/QyEZN3/Rt8Nr4SAZiQOlcBXOCpGvuIKOEAhvDOUnW3aDHL01PdVw== +"@aws-sdk/middleware-expect-continue@3.936.0": + version "3.936.0" + resolved "https://registry.yarnpkg.com/@aws-sdk/middleware-expect-continue/-/middleware-expect-continue-3.936.0.tgz#da1ce8a8b9af61192131a1c0a54bcab2a8a0e02f" + integrity sha512-Eb4ELAC23bEQLJmUMYnPWcjD3FZIsmz2svDiXEcxRkQU9r7NRID7pM7C5NPH94wOfiCk0b2Y8rVyFXW0lGQwbA== dependencies: - "@aws-sdk/types" "3.840.0" - "@smithy/protocol-http" "^5.1.2" - "@smithy/types" "^4.3.1" + "@aws-sdk/types" "3.936.0" + "@smithy/protocol-http" "^5.3.5" + "@smithy/types" "^4.9.0" tslib "^2.6.2" -"@aws-sdk/middleware-flexible-checksums@3.858.0": - version "3.858.0" - resolved "https://registry.yarnpkg.com/@aws-sdk/middleware-flexible-checksums/-/middleware-flexible-checksums-3.858.0.tgz#39a4040375ef223263e7d7afe0e49a7d3057d1dc" - integrity sha512-/GBerFXab3Mk5zkkTaOR1drR1IWMShiUbcEocCPig068/HnpjVSd9SP4+ro/ivG+zLOtxJdpjBcBKxCwQmefMA== +"@aws-sdk/middleware-flexible-checksums@3.943.0": + version "3.943.0" + resolved "https://registry.yarnpkg.com/@aws-sdk/middleware-flexible-checksums/-/middleware-flexible-checksums-3.943.0.tgz#b89a71bb7c3442eb40984a05137d70f775255257" + integrity sha512-J2oYbAQXTFEezs5m2Vij6H3w71K1hZfCtb85AsR/2Ovp/FjABMnK+Es1g1edRx6KuMTc9HkL/iGU4e+ek+qCZw== dependencies: "@aws-crypto/crc32" "5.2.0" "@aws-crypto/crc32c" "5.2.0" "@aws-crypto/util" "5.2.0" - "@aws-sdk/core" "3.858.0" - "@aws-sdk/types" "3.840.0" - "@smithy/is-array-buffer" "^4.0.0" - "@smithy/node-config-provider" "^4.1.3" - "@smithy/protocol-http" "^5.1.2" - "@smithy/types" "^4.3.1" - "@smithy/util-middleware" "^4.0.4" - "@smithy/util-stream" "^4.2.3" - "@smithy/util-utf8" "^4.0.0" + "@aws-sdk/core" "3.943.0" + "@aws-sdk/types" "3.936.0" + "@smithy/is-array-buffer" "^4.2.0" + "@smithy/node-config-provider" "^4.3.5" + "@smithy/protocol-http" "^5.3.5" + "@smithy/types" "^4.9.0" + "@smithy/util-middleware" "^4.2.5" + "@smithy/util-stream" "^4.5.6" + "@smithy/util-utf8" "^4.2.0" tslib "^2.6.2" -"@aws-sdk/middleware-host-header@3.840.0": - version "3.840.0" - resolved "https://registry.yarnpkg.com/@aws-sdk/middleware-host-header/-/middleware-host-header-3.840.0.tgz#7c8b163fb13d588b87523b53f7d98de73262e83f" - integrity sha512-ub+hXJAbAje94+Ya6c6eL7sYujoE8D4Bumu1NUI8TXjUhVVn0HzVWQjpRLshdLsUp1AW7XyeJaxyajRaJQ8+Xg== +"@aws-sdk/middleware-host-header@3.936.0": + version "3.936.0" + resolved "https://registry.yarnpkg.com/@aws-sdk/middleware-host-header/-/middleware-host-header-3.936.0.tgz#ef1144d175f1f499afbbd92ad07e24f8ccc9e9ce" + integrity sha512-tAaObaAnsP1XnLGndfkGWFuzrJYuk9W0b/nLvol66t8FZExIAf/WdkT2NNAWOYxljVs++oHnyHBCxIlaHrzSiw== dependencies: - "@aws-sdk/types" "3.840.0" - "@smithy/protocol-http" "^5.1.2" - "@smithy/types" "^4.3.1" + "@aws-sdk/types" "3.936.0" + "@smithy/protocol-http" "^5.3.5" + "@smithy/types" "^4.9.0" tslib "^2.6.2" -"@aws-sdk/middleware-location-constraint@3.840.0": - version "3.840.0" - resolved "https://registry.yarnpkg.com/@aws-sdk/middleware-location-constraint/-/middleware-location-constraint-3.840.0.tgz#5796cb59ae4e19d04c66cf69de73c59f9cc64241" - integrity sha512-KVLD0u0YMF3aQkVF8bdyHAGWSUY6N1Du89htTLgqCcIhSxxAJ9qifrosVZ9jkAzqRW99hcufyt2LylcVU2yoKQ== +"@aws-sdk/middleware-location-constraint@3.936.0": + version "3.936.0" + resolved "https://registry.yarnpkg.com/@aws-sdk/middleware-location-constraint/-/middleware-location-constraint-3.936.0.tgz#1f79ba7d2506f12b806689f22d687fb05db3614e" + integrity sha512-SCMPenDtQMd9o5da9JzkHz838w3327iqXk3cbNnXWqnNRx6unyW8FL0DZ84gIY12kAyVHz5WEqlWuekc15ehfw== dependencies: - "@aws-sdk/types" "3.840.0" - "@smithy/types" "^4.3.1" + "@aws-sdk/types" "3.936.0" + "@smithy/types" "^4.9.0" tslib "^2.6.2" -"@aws-sdk/middleware-logger@3.840.0": - version "3.840.0" - resolved "https://registry.yarnpkg.com/@aws-sdk/middleware-logger/-/middleware-logger-3.840.0.tgz#d92ade1817ac7dc78a3567c1239bb1a3f3b1b57a" - integrity sha512-lSV8FvjpdllpGaRspywss4CtXV8M7NNNH+2/j86vMH+YCOZ6fu2T/TyFd/tHwZ92vDfHctWkRbQxg0bagqwovA== +"@aws-sdk/middleware-logger@3.936.0": + version "3.936.0" + resolved "https://registry.yarnpkg.com/@aws-sdk/middleware-logger/-/middleware-logger-3.936.0.tgz#691093bebb708b994be10f19358e8699af38a209" + integrity sha512-aPSJ12d3a3Ea5nyEnLbijCaaYJT2QjQ9iW+zGh5QcZYXmOGWbKVyPSxmVOboZQG+c1M8t6d2O7tqrwzIq8L8qw== dependencies: - "@aws-sdk/types" "3.840.0" - "@smithy/types" "^4.3.1" + "@aws-sdk/types" "3.936.0" + "@smithy/types" "^4.9.0" tslib "^2.6.2" -"@aws-sdk/middleware-recursion-detection@3.840.0": - version "3.840.0" - resolved "https://registry.yarnpkg.com/@aws-sdk/middleware-recursion-detection/-/middleware-recursion-detection-3.840.0.tgz#8ea2c00af258db0b64ea394e044cedb6101b5ffd" - integrity sha512-Gu7lGDyfddyhIkj1Z1JtrY5NHb5+x/CRiB87GjaSrKxkDaydtX2CU977JIABtt69l9wLbcGDIQ+W0uJ5xPof7g== +"@aws-sdk/middleware-recursion-detection@3.936.0": + version "3.936.0" + resolved "https://registry.yarnpkg.com/@aws-sdk/middleware-recursion-detection/-/middleware-recursion-detection-3.936.0.tgz#141b6c92c1aa42bcd71aa854e0783b4f28e87a30" + integrity sha512-l4aGbHpXM45YNgXggIux1HgsCVAvvBoqHPkqLnqMl9QVapfuSTjJHfDYDsx1Xxct6/m7qSMUzanBALhiaGO2fA== dependencies: - "@aws-sdk/types" "3.840.0" - "@smithy/protocol-http" "^5.1.2" - "@smithy/types" "^4.3.1" + "@aws-sdk/types" "3.936.0" + "@aws/lambda-invoke-store" "^0.2.0" + "@smithy/protocol-http" "^5.3.5" + "@smithy/types" "^4.9.0" tslib "^2.6.2" -"@aws-sdk/middleware-sdk-s3@3.858.0": - version "3.858.0" - resolved "https://registry.yarnpkg.com/@aws-sdk/middleware-sdk-s3/-/middleware-sdk-s3-3.858.0.tgz#48eae3b04e97ec448f57449001fe4ddfd9ba5ffb" - integrity sha512-g1LBHK9iAAMnh4rRX4/cGBuICH5R9boHUw4X9FkMC+ROAH9z1A2uy6bE55sg5guheAmVTQ5sOsVZb8QPEQbIUA== - dependencies: - "@aws-sdk/core" "3.858.0" - "@aws-sdk/types" "3.840.0" - "@aws-sdk/util-arn-parser" "3.804.0" - "@smithy/core" "^3.7.2" - "@smithy/node-config-provider" "^4.1.3" - "@smithy/protocol-http" "^5.1.2" - "@smithy/signature-v4" "^5.1.2" - "@smithy/smithy-client" "^4.4.9" - "@smithy/types" "^4.3.1" - "@smithy/util-config-provider" "^4.0.0" - "@smithy/util-middleware" "^4.0.4" - "@smithy/util-stream" "^4.2.3" - "@smithy/util-utf8" "^4.0.0" +"@aws-sdk/middleware-sdk-s3@3.943.0": + version "3.943.0" + resolved "https://registry.yarnpkg.com/@aws-sdk/middleware-sdk-s3/-/middleware-sdk-s3-3.943.0.tgz#d0a422ca358bfa72572ca6acd307b3d2a1863b58" + integrity sha512-kd2mALfthU+RS9NsPS+qvznFcPnVgVx9mgmStWCPn5Qc5BTnx4UAtm+HPA+XZs+zxOopp+zmAfE4qxDHRVONBA== + dependencies: + "@aws-sdk/core" "3.943.0" + "@aws-sdk/types" "3.936.0" + "@aws-sdk/util-arn-parser" "3.893.0" + "@smithy/core" "^3.18.5" + "@smithy/node-config-provider" "^4.3.5" + "@smithy/protocol-http" "^5.3.5" + "@smithy/signature-v4" "^5.3.5" + "@smithy/smithy-client" "^4.9.8" + "@smithy/types" "^4.9.0" + "@smithy/util-config-provider" "^4.2.0" + "@smithy/util-middleware" "^4.2.5" + "@smithy/util-stream" "^4.5.6" + "@smithy/util-utf8" "^4.2.0" tslib "^2.6.2" -"@aws-sdk/middleware-ssec@3.840.0": - version "3.840.0" - resolved "https://registry.yarnpkg.com/@aws-sdk/middleware-ssec/-/middleware-ssec-3.840.0.tgz#64252d11c21d99690abc51a6fabf1ea7144d40ac" - integrity sha512-CBZP9t1QbjDFGOrtnUEHL1oAvmnCUUm7p0aPNbIdSzNtH42TNKjPRN3TuEIJDGjkrqpL3MXyDSmNayDcw/XW7Q== +"@aws-sdk/middleware-ssec@3.936.0": + version "3.936.0" + resolved "https://registry.yarnpkg.com/@aws-sdk/middleware-ssec/-/middleware-ssec-3.936.0.tgz#7a56e6946a86ce4f4489459e5188091116e8ddba" + integrity sha512-/GLC9lZdVp05ozRik5KsuODR/N7j+W+2TbfdFL3iS+7un+gnP6hC8RDOZd6WhpZp7drXQ9guKiTAxkZQwzS8DA== dependencies: - "@aws-sdk/types" "3.840.0" - "@smithy/types" "^4.3.1" + "@aws-sdk/types" "3.936.0" + "@smithy/types" "^4.9.0" tslib "^2.6.2" -"@aws-sdk/middleware-user-agent@3.858.0": - version "3.858.0" - resolved "https://registry.yarnpkg.com/@aws-sdk/middleware-user-agent/-/middleware-user-agent-3.858.0.tgz#fee39eb6e5c56e704880f18efaf76ce60be980b0" - integrity sha512-pC3FT/sRZ6n5NyXiTVu9dpf1D9j3YbJz3XmeOOwJqO/Mib2PZyIQktvNMPgwaC5KMVB1zWqS5bmCwxpMOnq0UQ== - dependencies: - "@aws-sdk/core" "3.858.0" - "@aws-sdk/types" "3.840.0" - "@aws-sdk/util-endpoints" "3.848.0" - "@smithy/core" "^3.7.2" - "@smithy/protocol-http" "^5.1.2" - "@smithy/types" "^4.3.1" +"@aws-sdk/middleware-user-agent@3.943.0": + version "3.943.0" + resolved "https://registry.yarnpkg.com/@aws-sdk/middleware-user-agent/-/middleware-user-agent-3.943.0.tgz#df81ae94cf928929e14f9e4ceb8176c82e32bfdb" + integrity sha512-956n4kVEwFNXndXfhSAN5wO+KRgqiWEEY+ECwLvxmmO8uQ0NWOa8l6l65nTtyuiWzMX81c9BvlyNR5EgUeeUvA== + dependencies: + "@aws-sdk/core" "3.943.0" + "@aws-sdk/types" "3.936.0" + "@aws-sdk/util-endpoints" "3.936.0" + "@smithy/core" "^3.18.5" + "@smithy/protocol-http" "^5.3.5" + "@smithy/types" "^4.9.0" tslib "^2.6.2" -"@aws-sdk/nested-clients@3.858.0": - version "3.858.0" - resolved "https://registry.yarnpkg.com/@aws-sdk/nested-clients/-/nested-clients-3.858.0.tgz#171466f44a65818b6233fd38dae6116344bd4401" - integrity sha512-ChdIj80T2whoWbovmO7o8ICmhEB2S9q4Jes9MBnKAPm69PexcJAK2dQC8yI4/iUP8b3+BHZoUPrYLWjBxIProQ== +"@aws-sdk/nested-clients@3.943.0": + version "3.943.0" + resolved "https://registry.yarnpkg.com/@aws-sdk/nested-clients/-/nested-clients-3.943.0.tgz#90fd20adb210926c204f6c0896d0531570e1213d" + integrity sha512-anFtB0p2FPuyUnbOULwGmKYqYKSq1M73c9uZ08jR/NCq6Trjq9cuF5TFTeHwjJyPRb4wMf2Qk859oiVfFqnQiw== dependencies: "@aws-crypto/sha256-browser" "5.2.0" "@aws-crypto/sha256-js" "5.2.0" - "@aws-sdk/core" "3.858.0" - "@aws-sdk/middleware-host-header" "3.840.0" - "@aws-sdk/middleware-logger" "3.840.0" - "@aws-sdk/middleware-recursion-detection" "3.840.0" - "@aws-sdk/middleware-user-agent" "3.858.0" - "@aws-sdk/region-config-resolver" "3.840.0" - "@aws-sdk/types" "3.840.0" - "@aws-sdk/util-endpoints" "3.848.0" - "@aws-sdk/util-user-agent-browser" "3.840.0" - "@aws-sdk/util-user-agent-node" "3.858.0" - "@smithy/config-resolver" "^4.1.4" - "@smithy/core" "^3.7.2" - "@smithy/fetch-http-handler" "^5.1.0" - "@smithy/hash-node" "^4.0.4" - "@smithy/invalid-dependency" "^4.0.4" - "@smithy/middleware-content-length" "^4.0.4" - "@smithy/middleware-endpoint" "^4.1.17" - "@smithy/middleware-retry" "^4.1.18" - "@smithy/middleware-serde" "^4.0.8" - "@smithy/middleware-stack" "^4.0.4" - "@smithy/node-config-provider" "^4.1.3" - "@smithy/node-http-handler" "^4.1.0" - "@smithy/protocol-http" "^5.1.2" - "@smithy/smithy-client" "^4.4.9" - "@smithy/types" "^4.3.1" - "@smithy/url-parser" "^4.0.4" - "@smithy/util-base64" "^4.0.0" - "@smithy/util-body-length-browser" "^4.0.0" - "@smithy/util-body-length-node" "^4.0.0" - "@smithy/util-defaults-mode-browser" "^4.0.25" - "@smithy/util-defaults-mode-node" "^4.0.25" - "@smithy/util-endpoints" "^3.0.6" - "@smithy/util-middleware" "^4.0.4" - "@smithy/util-retry" "^4.0.6" - "@smithy/util-utf8" "^4.0.0" + "@aws-sdk/core" "3.943.0" + "@aws-sdk/middleware-host-header" "3.936.0" + "@aws-sdk/middleware-logger" "3.936.0" + "@aws-sdk/middleware-recursion-detection" "3.936.0" + "@aws-sdk/middleware-user-agent" "3.943.0" + "@aws-sdk/region-config-resolver" "3.936.0" + "@aws-sdk/types" "3.936.0" + "@aws-sdk/util-endpoints" "3.936.0" + "@aws-sdk/util-user-agent-browser" "3.936.0" + "@aws-sdk/util-user-agent-node" "3.943.0" + "@smithy/config-resolver" "^4.4.3" + "@smithy/core" "^3.18.5" + "@smithy/fetch-http-handler" "^5.3.6" + "@smithy/hash-node" "^4.2.5" + "@smithy/invalid-dependency" "^4.2.5" + "@smithy/middleware-content-length" "^4.2.5" + "@smithy/middleware-endpoint" "^4.3.12" + "@smithy/middleware-retry" "^4.4.12" + "@smithy/middleware-serde" "^4.2.6" + "@smithy/middleware-stack" "^4.2.5" + "@smithy/node-config-provider" "^4.3.5" + "@smithy/node-http-handler" "^4.4.5" + "@smithy/protocol-http" "^5.3.5" + "@smithy/smithy-client" "^4.9.8" + "@smithy/types" "^4.9.0" + "@smithy/url-parser" "^4.2.5" + "@smithy/util-base64" "^4.3.0" + "@smithy/util-body-length-browser" "^4.2.0" + "@smithy/util-body-length-node" "^4.2.1" + "@smithy/util-defaults-mode-browser" "^4.3.11" + "@smithy/util-defaults-mode-node" "^4.2.14" + "@smithy/util-endpoints" "^3.2.5" + "@smithy/util-middleware" "^4.2.5" + "@smithy/util-retry" "^4.2.5" + "@smithy/util-utf8" "^4.2.0" tslib "^2.6.2" -"@aws-sdk/region-config-resolver@3.840.0": - version "3.840.0" - resolved "https://registry.yarnpkg.com/@aws-sdk/region-config-resolver/-/region-config-resolver-3.840.0.tgz#240690ead3131c4c47186b4929776439fe2f6729" - integrity sha512-Qjnxd/yDv9KpIMWr90ZDPtRj0v75AqGC92Lm9+oHXZ8p1MjG5JE2CW0HL8JRgK9iKzgKBL7pPQRXI8FkvEVfrA== +"@aws-sdk/region-config-resolver@3.936.0": + version "3.936.0" + resolved "https://registry.yarnpkg.com/@aws-sdk/region-config-resolver/-/region-config-resolver-3.936.0.tgz#b02f20c4d62973731d42da1f1239a27fbbe53c0a" + integrity sha512-wOKhzzWsshXGduxO4pqSiNyL9oUtk4BEvjWm9aaq6Hmfdoydq6v6t0rAGHWPjFwy9z2haovGRi3C8IxdMB4muw== dependencies: - "@aws-sdk/types" "3.840.0" - "@smithy/node-config-provider" "^4.1.3" - "@smithy/types" "^4.3.1" - "@smithy/util-config-provider" "^4.0.0" - "@smithy/util-middleware" "^4.0.4" + "@aws-sdk/types" "3.936.0" + "@smithy/config-resolver" "^4.4.3" + "@smithy/node-config-provider" "^4.3.5" + "@smithy/types" "^4.9.0" tslib "^2.6.2" "@aws-sdk/s3-request-presigner@^3.858.0": - version "3.858.0" - resolved "https://registry.yarnpkg.com/@aws-sdk/s3-request-presigner/-/s3-request-presigner-3.858.0.tgz#1eabc50de7ed113f0294062562998d85573d59a9" - integrity sha512-eO/dLe0b/72U+I5Df8J5GQajrRMrUQpsHibc5doD9LnfTlKe9MwOZbQ6Xo5qKElSqRqL+g2udohttBTE2NRw8w== - dependencies: - "@aws-sdk/signature-v4-multi-region" "3.858.0" - "@aws-sdk/types" "3.840.0" - "@aws-sdk/util-format-url" "3.840.0" - "@smithy/middleware-endpoint" "^4.1.17" - "@smithy/protocol-http" "^5.1.2" - "@smithy/smithy-client" "^4.4.9" - "@smithy/types" "^4.3.1" + version "3.943.0" + resolved "https://registry.yarnpkg.com/@aws-sdk/s3-request-presigner/-/s3-request-presigner-3.943.0.tgz#dcfc37ef5ab92d11cc3ab43eed03ced993ea2fdd" + integrity sha512-r79MlUb7jeydV0caSz/emoyttzDdxgSkS/8ZU3lawkoTTnWCt+1nB4VA2xzOAPzP2dSdwNVpuAdY7uD1t2f0wA== + dependencies: + "@aws-sdk/signature-v4-multi-region" "3.943.0" + "@aws-sdk/types" "3.936.0" + "@aws-sdk/util-format-url" "3.936.0" + "@smithy/middleware-endpoint" "^4.3.12" + "@smithy/protocol-http" "^5.3.5" + "@smithy/smithy-client" "^4.9.8" + "@smithy/types" "^4.9.0" tslib "^2.6.2" -"@aws-sdk/signature-v4-multi-region@3.858.0": - version "3.858.0" - resolved "https://registry.yarnpkg.com/@aws-sdk/signature-v4-multi-region/-/signature-v4-multi-region-3.858.0.tgz#59e1731ce3da1027bcfa28944d21e520a6d31b01" - integrity sha512-WtQvCtIz8KzTqd/OhjziWb5nAFDEZ0pE1KJsWBZ0j6Ngvp17ORSY37U96buU0SlNNflloGT7ZIlDkdFh73YktA== +"@aws-sdk/signature-v4-multi-region@3.943.0": + version "3.943.0" + resolved "https://registry.yarnpkg.com/@aws-sdk/signature-v4-multi-region/-/signature-v4-multi-region-3.943.0.tgz#3fbb5b6a6cdcc425c4a6733133089149f106a0f5" + integrity sha512-KKvmxNQ/FZbM6ml6nKd8ltDulsUojsXnMJNgf1VHTcJEbADC/6mVWOq0+e9D0WP1qixUBEuMjlS2HqD5KoqwEg== dependencies: - "@aws-sdk/middleware-sdk-s3" "3.858.0" - "@aws-sdk/types" "3.840.0" - "@smithy/protocol-http" "^5.1.2" - "@smithy/signature-v4" "^5.1.2" - "@smithy/types" "^4.3.1" + "@aws-sdk/middleware-sdk-s3" "3.943.0" + "@aws-sdk/types" "3.936.0" + "@smithy/protocol-http" "^5.3.5" + "@smithy/signature-v4" "^5.3.5" + "@smithy/types" "^4.9.0" tslib "^2.6.2" -"@aws-sdk/token-providers@3.858.0": - version "3.858.0" - resolved "https://registry.yarnpkg.com/@aws-sdk/token-providers/-/token-providers-3.858.0.tgz#6261263342a93a89300de7224ef2580dc716db89" - integrity sha512-uQ3cVpqbkaxq3Hd8zip0pcOFsP731g+m0zsobQ7Bmqjq4/PHcehTov8i3W9+7sBHocOM61/qrQksPlW0TPuPAA== - dependencies: - "@aws-sdk/core" "3.858.0" - "@aws-sdk/nested-clients" "3.858.0" - "@aws-sdk/types" "3.840.0" - "@smithy/property-provider" "^4.0.4" - "@smithy/shared-ini-file-loader" "^4.0.4" - "@smithy/types" "^4.3.1" +"@aws-sdk/token-providers@3.943.0": + version "3.943.0" + resolved "https://registry.yarnpkg.com/@aws-sdk/token-providers/-/token-providers-3.943.0.tgz#f3dbc0764f9372e47b1312c13d3070217c1767ed" + integrity sha512-cRKyIzwfkS+XztXIFPoWORuaxlIswP+a83BJzelX4S1gUZ7FcXB4+lj9Jxjn8SbQhR4TPU3Owbpu+S7pd6IRbQ== + dependencies: + "@aws-sdk/core" "3.943.0" + "@aws-sdk/nested-clients" "3.943.0" + "@aws-sdk/types" "3.936.0" + "@smithy/property-provider" "^4.2.5" + "@smithy/shared-ini-file-loader" "^4.4.0" + "@smithy/types" "^4.9.0" tslib "^2.6.2" -"@aws-sdk/types@3.840.0", "@aws-sdk/types@^3.222.0": - version "3.840.0" - resolved "https://registry.yarnpkg.com/@aws-sdk/types/-/types-3.840.0.tgz#aadc6843d5c1f24b3d1d228059e702a355bf07c3" - integrity sha512-xliuHaUFZxEx1NSXeLLZ9Dyu6+EJVQKEoD+yM+zqUo3YDZ7medKJWY6fIOKiPX/N7XbLdBYwajb15Q7IL8KkeA== +"@aws-sdk/types@3.936.0", "@aws-sdk/types@^3.222.0": + version "3.936.0" + resolved "https://registry.yarnpkg.com/@aws-sdk/types/-/types-3.936.0.tgz#ecd3a4bec1a1bd4df834ab21fe52a76e332dc27a" + integrity sha512-uz0/VlMd2pP5MepdrHizd+T+OKfyK4r3OA9JI+L/lPKg0YFQosdJNCKisr6o70E3dh8iMpFYxF1UN/4uZsyARg== dependencies: - "@smithy/types" "^4.3.1" + "@smithy/types" "^4.9.0" tslib "^2.6.2" -"@aws-sdk/util-arn-parser@3.804.0": - version "3.804.0" - resolved "https://registry.yarnpkg.com/@aws-sdk/util-arn-parser/-/util-arn-parser-3.804.0.tgz#d0b52bf5f9ae5b2c357a635551e5844dcad074c8" - integrity sha512-wmBJqn1DRXnZu3b4EkE6CWnoWMo1ZMvlfkqU5zPz67xx1GMaXlDCchFvKAXMjk4jn/L1O3tKnoFDNsoLV1kgNQ== +"@aws-sdk/util-arn-parser@3.893.0": + version "3.893.0" + resolved "https://registry.yarnpkg.com/@aws-sdk/util-arn-parser/-/util-arn-parser-3.893.0.tgz#fcc9b792744b9da597662891c2422dda83881d8d" + integrity sha512-u8H4f2Zsi19DGnwj5FSZzDMhytYF/bCh37vAtBsn3cNDL3YG578X5oc+wSX54pM3tOxS+NY7tvOAo52SW7koUA== dependencies: tslib "^2.6.2" -"@aws-sdk/util-endpoints@3.848.0": - version "3.848.0" - resolved "https://registry.yarnpkg.com/@aws-sdk/util-endpoints/-/util-endpoints-3.848.0.tgz#dea15ac0949fcbc518426fb4a86d1e9bd53433db" - integrity sha512-fY/NuFFCq/78liHvRyFKr+aqq1aA/uuVSANjzr5Ym8c+9Z3HRPE9OrExAHoMrZ6zC8tHerQwlsXYYH5XZ7H+ww== +"@aws-sdk/util-endpoints@3.936.0": + version "3.936.0" + resolved "https://registry.yarnpkg.com/@aws-sdk/util-endpoints/-/util-endpoints-3.936.0.tgz#81c00be8cfd4f966e05defd739a720ce2c888ddf" + integrity sha512-0Zx3Ntdpu+z9Wlm7JKUBOzS9EunwKAb4KdGUQQxDqh5Lc3ta5uBoub+FgmVuzwnmBu9U1Os8UuwVTH0Lgu+P5w== dependencies: - "@aws-sdk/types" "3.840.0" - "@smithy/types" "^4.3.1" - "@smithy/url-parser" "^4.0.4" - "@smithy/util-endpoints" "^3.0.6" + "@aws-sdk/types" "3.936.0" + "@smithy/types" "^4.9.0" + "@smithy/url-parser" "^4.2.5" + "@smithy/util-endpoints" "^3.2.5" tslib "^2.6.2" -"@aws-sdk/util-format-url@3.840.0": - version "3.840.0" - resolved "https://registry.yarnpkg.com/@aws-sdk/util-format-url/-/util-format-url-3.840.0.tgz#386f703f9048f0a297ec2f4e37a9bfbb84a0aa18" - integrity sha512-VB1PWyI1TQPiPvg4w7tgUGGQER1xxXPNUqfh3baxUSFi1Oh8wHrDnFywkxLm3NMmgDmnLnSZ5Q326qAoyqKLSg== +"@aws-sdk/util-format-url@3.936.0": + version "3.936.0" + resolved "https://registry.yarnpkg.com/@aws-sdk/util-format-url/-/util-format-url-3.936.0.tgz#66070d028d2db66729face62d75468bea4c25eee" + integrity sha512-MS5eSEtDUFIAMHrJaMERiHAvDPdfxc/T869ZjDNFAIiZhyc037REw0aoTNeimNXDNy2txRNZJaAUn/kE4RwN+g== dependencies: - "@aws-sdk/types" "3.840.0" - "@smithy/querystring-builder" "^4.0.4" - "@smithy/types" "^4.3.1" + "@aws-sdk/types" "3.936.0" + "@smithy/querystring-builder" "^4.2.5" + "@smithy/types" "^4.9.0" tslib "^2.6.2" "@aws-sdk/util-locate-window@^3.0.0": - version "3.804.0" - resolved "https://registry.yarnpkg.com/@aws-sdk/util-locate-window/-/util-locate-window-3.804.0.tgz#a2ee8dc5d9c98276986e8e1ba03c0c84d9afb0f5" - integrity sha512-zVoRfpmBVPodYlnMjgVjfGoEZagyRF5IPn3Uo6ZvOZp24chnW/FRstH7ESDHDDRga4z3V+ElUQHKpFDXWyBW5A== + version "3.893.0" + resolved "https://registry.yarnpkg.com/@aws-sdk/util-locate-window/-/util-locate-window-3.893.0.tgz#5df15f24e1edbe12ff1fe8906f823b51cd53bae8" + integrity sha512-T89pFfgat6c8nMmpI8eKjBcDcgJq36+m9oiXbcUzeU55MP9ZuGgBomGjGnHaEyF36jenW9gmg3NfZDm0AO2XPg== dependencies: tslib "^2.6.2" -"@aws-sdk/util-user-agent-browser@3.840.0": - version "3.840.0" - resolved "https://registry.yarnpkg.com/@aws-sdk/util-user-agent-browser/-/util-user-agent-browser-3.840.0.tgz#6c2f55494352a86048c52852b0c357bb21905984" - integrity sha512-JdyZM3EhhL4PqwFpttZu1afDpPJCCc3eyZOLi+srpX11LsGj6sThf47TYQN75HT1CarZ7cCdQHGzP2uy3/xHfQ== +"@aws-sdk/util-user-agent-browser@3.936.0": + version "3.936.0" + resolved "https://registry.yarnpkg.com/@aws-sdk/util-user-agent-browser/-/util-user-agent-browser-3.936.0.tgz#cbfcaeaba6d843b060183638699c0f20dcaed774" + integrity sha512-eZ/XF6NxMtu+iCma58GRNRxSq4lHo6zHQLOZRIeL/ghqYJirqHdenMOwrzPettj60KWlv827RVebP9oNVrwZbw== dependencies: - "@aws-sdk/types" "3.840.0" - "@smithy/types" "^4.3.1" + "@aws-sdk/types" "3.936.0" + "@smithy/types" "^4.9.0" bowser "^2.11.0" tslib "^2.6.2" -"@aws-sdk/util-user-agent-node@3.858.0": - version "3.858.0" - resolved "https://registry.yarnpkg.com/@aws-sdk/util-user-agent-node/-/util-user-agent-node-3.858.0.tgz#bdf767443486371f1c7432dd4d1e178f8a45074c" - integrity sha512-T1m05QlN8hFpx5/5duMjS8uFSK5e6EXP45HQRkZULVkL3DK+jMaxsnh3KLl5LjUoHn/19M4HM0wNUBhYp4Y2Yw== +"@aws-sdk/util-user-agent-node@3.943.0": + version "3.943.0" + resolved "https://registry.yarnpkg.com/@aws-sdk/util-user-agent-node/-/util-user-agent-node-3.943.0.tgz#c584caf251b06a6e46f0ad2417215e6d22bd1077" + integrity sha512-gn+ILprVRrgAgTIBk2TDsJLRClzIOdStQFeFTcN0qpL8Z4GBCqMFhw7O7X+MM55Stt5s4jAauQ/VvoqmCADnQg== dependencies: - "@aws-sdk/middleware-user-agent" "3.858.0" - "@aws-sdk/types" "3.840.0" - "@smithy/node-config-provider" "^4.1.3" - "@smithy/types" "^4.3.1" + "@aws-sdk/middleware-user-agent" "3.943.0" + "@aws-sdk/types" "3.936.0" + "@smithy/node-config-provider" "^4.3.5" + "@smithy/types" "^4.9.0" tslib "^2.6.2" -"@aws-sdk/xml-builder@3.821.0": - version "3.821.0" - resolved "https://registry.yarnpkg.com/@aws-sdk/xml-builder/-/xml-builder-3.821.0.tgz#ff89bf1276fca41276ed508b9c8ae21978d91177" - integrity sha512-DIIotRnefVL6DiaHtO6/21DhJ4JZnnIwdNbpwiAhdt/AVbttcE4yw925gsjur0OGv5BTYXQXU3YnANBYnZjuQA== +"@aws-sdk/xml-builder@3.930.0": + version "3.930.0" + resolved "https://registry.yarnpkg.com/@aws-sdk/xml-builder/-/xml-builder-3.930.0.tgz#949a35219ca52cc769ffbfbf38f3324178ba74f9" + integrity sha512-YIfkD17GocxdmlUVc3ia52QhcWuRIUJonbF8A2CYfcWNV3HzvAqpcPeC0bYUhkK+8e8YO1ARnLKZQE0TlwzorA== dependencies: - "@smithy/types" "^4.3.1" + "@smithy/types" "^4.9.0" + fast-xml-parser "5.2.5" tslib "^2.6.2" +"@aws/lambda-invoke-store@^0.2.0": + version "0.2.1" + resolved "https://registry.yarnpkg.com/@aws/lambda-invoke-store/-/lambda-invoke-store-0.2.1.tgz#ceecff9ebe1f6199369e6911f38633fac3322811" + integrity sha512-sIyFcoPZkTtNu9xFeEoynMef3bPJIAbOfUh+ueYcfhVl6xm2VRtMcMclSxmZCMnHHd4hlYKJeq/aggmBEWynww== + "@babel/code-frame@^7.27.1": version "7.27.1" resolved "https://registry.yarnpkg.com/@babel/code-frame/-/code-frame-7.27.1.tgz#200f715e66d52a23b221a9435534a91cc13ad5be" @@ -608,38 +617,38 @@ picocolors "^1.1.1" "@babel/compat-data@^7.27.2": - version "7.28.0" - resolved "https://registry.yarnpkg.com/@babel/compat-data/-/compat-data-7.28.0.tgz#9fc6fd58c2a6a15243cd13983224968392070790" - integrity sha512-60X7qkglvrap8mn1lh2ebxXdZYtUcpd7gsmy9kLaBJ4i/WdY8PqTSdxyA8qraikqKQK5C1KRBKXqznrVapyNaw== + version "7.28.5" + resolved "https://registry.yarnpkg.com/@babel/compat-data/-/compat-data-7.28.5.tgz#a8a4962e1567121ac0b3b487f52107443b455c7f" + integrity sha512-6uFXyCayocRbqhZOB+6XcuZbkMNimwfVGFji8CTZnCzOHVGvDqzvitu1re2AU5LROliz7eQPhB8CpAMvnx9EjA== "@babel/core@^7.23.9": - version "7.28.0" - resolved "https://registry.yarnpkg.com/@babel/core/-/core-7.28.0.tgz#55dad808d5bf3445a108eefc88ea3fdf034749a4" - integrity sha512-UlLAnTPrFdNGoFtbSXwcGFQBtQZJCNjaN6hQNP3UPvuNXT1i82N26KL3dZeIpNalWywr9IuQuncaAfUaS1g6sQ== + version "7.28.5" + resolved "https://registry.yarnpkg.com/@babel/core/-/core-7.28.5.tgz#4c81b35e51e1b734f510c99b07dfbc7bbbb48f7e" + integrity sha512-e7jT4DxYvIDLk1ZHmU/m/mB19rex9sv0c2ftBtjSBv+kVM/902eh0fINUzD7UwLLNR+jU585GxUJ8/EBfAM5fw== dependencies: - "@ampproject/remapping" "^2.2.0" "@babel/code-frame" "^7.27.1" - "@babel/generator" "^7.28.0" + "@babel/generator" "^7.28.5" "@babel/helper-compilation-targets" "^7.27.2" - "@babel/helper-module-transforms" "^7.27.3" - "@babel/helpers" "^7.27.6" - "@babel/parser" "^7.28.0" + "@babel/helper-module-transforms" "^7.28.3" + "@babel/helpers" "^7.28.4" + "@babel/parser" "^7.28.5" "@babel/template" "^7.27.2" - "@babel/traverse" "^7.28.0" - "@babel/types" "^7.28.0" + "@babel/traverse" "^7.28.5" + "@babel/types" "^7.28.5" + "@jridgewell/remapping" "^2.3.5" convert-source-map "^2.0.0" debug "^4.1.0" gensync "^1.0.0-beta.2" json5 "^2.2.3" semver "^6.3.1" -"@babel/generator@^7.28.0": - version "7.28.0" - resolved "https://registry.yarnpkg.com/@babel/generator/-/generator-7.28.0.tgz#9cc2f7bd6eb054d77dc66c2664148a0c5118acd2" - integrity sha512-lJjzvrbEeWrhB4P3QBsH7tey117PjLZnDbLiQEKjQ/fNJTjuq4HSqgFA+UNSwZT8D7dxxbnuSBMsa1lrWzKlQg== +"@babel/generator@^7.28.5": + version "7.28.5" + resolved "https://registry.yarnpkg.com/@babel/generator/-/generator-7.28.5.tgz#712722d5e50f44d07bc7ac9fe84438742dd61298" + integrity sha512-3EwLFhZ38J4VyIP6WNtt2kUdW9dokXA9Cr4IVIFHuCpZ3H8/YFOl5JjZHisrn1fATPBmKKqXzDFvh9fUwHz6CQ== dependencies: - "@babel/parser" "^7.28.0" - "@babel/types" "^7.28.0" + "@babel/parser" "^7.28.5" + "@babel/types" "^7.28.5" "@jridgewell/gen-mapping" "^0.3.12" "@jridgewell/trace-mapping" "^0.3.28" jsesc "^3.0.2" @@ -668,44 +677,44 @@ "@babel/traverse" "^7.27.1" "@babel/types" "^7.27.1" -"@babel/helper-module-transforms@^7.27.3": - version "7.27.3" - resolved "https://registry.yarnpkg.com/@babel/helper-module-transforms/-/helper-module-transforms-7.27.3.tgz#db0bbcfba5802f9ef7870705a7ef8788508ede02" - integrity sha512-dSOvYwvyLsWBeIRyOeHXp5vPj5l1I011r52FM1+r1jCERv+aFXYk4whgQccYEGYxK2H3ZAIA8nuPkQ0HaUo3qg== +"@babel/helper-module-transforms@^7.28.3": + version "7.28.3" + resolved "https://registry.yarnpkg.com/@babel/helper-module-transforms/-/helper-module-transforms-7.28.3.tgz#a2b37d3da3b2344fe085dab234426f2b9a2fa5f6" + integrity sha512-gytXUbs8k2sXS9PnQptz5o0QnpLL51SwASIORY6XaBKF88nsOT0Zw9szLqlSGQDP/4TljBAD5y98p2U1fqkdsw== dependencies: "@babel/helper-module-imports" "^7.27.1" "@babel/helper-validator-identifier" "^7.27.1" - "@babel/traverse" "^7.27.3" + "@babel/traverse" "^7.28.3" "@babel/helper-string-parser@^7.27.1": version "7.27.1" resolved "https://registry.yarnpkg.com/@babel/helper-string-parser/-/helper-string-parser-7.27.1.tgz#54da796097ab19ce67ed9f88b47bb2ec49367687" integrity sha512-qMlSxKbpRlAridDExk92nSobyDdpPijUq2DW6oDnUqd0iOGxmQjyqhMIihI9+zv4LPyZdRje2cavWPbCbWm3eA== -"@babel/helper-validator-identifier@^7.27.1": - version "7.27.1" - resolved "https://registry.yarnpkg.com/@babel/helper-validator-identifier/-/helper-validator-identifier-7.27.1.tgz#a7054dcc145a967dd4dc8fee845a57c1316c9df8" - integrity sha512-D2hP9eA+Sqx1kBZgzxZh0y1trbuU+JoDkiEwqhQ36nodYqJwyEIhPSdMNd7lOm/4io72luTPWH20Yda0xOuUow== +"@babel/helper-validator-identifier@^7.27.1", "@babel/helper-validator-identifier@^7.28.5": + version "7.28.5" + resolved "https://registry.yarnpkg.com/@babel/helper-validator-identifier/-/helper-validator-identifier-7.28.5.tgz#010b6938fab7cb7df74aa2bbc06aa503b8fe5fb4" + integrity sha512-qSs4ifwzKJSV39ucNjsvc6WVHs6b7S03sOh2OcHF9UHfVPqWWALUsNUVzhSBiItjRZoLHx7nIarVjqKVusUZ1Q== "@babel/helper-validator-option@^7.27.1": version "7.27.1" resolved "https://registry.yarnpkg.com/@babel/helper-validator-option/-/helper-validator-option-7.27.1.tgz#fa52f5b1e7db1ab049445b421c4471303897702f" integrity sha512-YvjJow9FxbhFFKDSuFnVCe2WxXk1zWc22fFePVNEaWJEu8IrZVlda6N0uHwzZrUM1il7NC9Mlp4MaJYbYd9JSg== -"@babel/helpers@^7.27.6": - version "7.28.2" - resolved "https://registry.yarnpkg.com/@babel/helpers/-/helpers-7.28.2.tgz#80f0918fecbfebea9af856c419763230040ee850" - integrity sha512-/V9771t+EgXz62aCcyofnQhGM8DQACbRhvzKFsXKC9QM+5MadF8ZmIm0crDMaz3+o0h0zXfJnd4EhbYbxsrcFw== +"@babel/helpers@^7.28.4": + version "7.28.4" + resolved "https://registry.yarnpkg.com/@babel/helpers/-/helpers-7.28.4.tgz#fe07274742e95bdf7cf1443593eeb8926ab63827" + integrity sha512-HFN59MmQXGHVyYadKLVumYsA9dBFun/ldYxipEjzA4196jpLZd8UjEEBLkbEkvfYreDqJhZxYAWFPtrfhNpj4w== dependencies: "@babel/template" "^7.27.2" - "@babel/types" "^7.28.2" + "@babel/types" "^7.28.4" -"@babel/parser@^7.23.9", "@babel/parser@^7.27.2", "@babel/parser@^7.28.0": - version "7.28.0" - resolved "https://registry.yarnpkg.com/@babel/parser/-/parser-7.28.0.tgz#979829fbab51a29e13901e5a80713dbcb840825e" - integrity sha512-jVZGvOxOuNSsuQuLRTh13nU0AogFlw32w/MT+LV6D3sP5WdbW61E77RnkbaO2dUvmPAYrBDJXGn5gGS6tH4j8g== +"@babel/parser@^7.23.9", "@babel/parser@^7.27.2", "@babel/parser@^7.28.5": + version "7.28.5" + resolved "https://registry.yarnpkg.com/@babel/parser/-/parser-7.28.5.tgz#0b0225ee90362f030efd644e8034c99468893b08" + integrity sha512-KKBU1VGYR7ORr3At5HAtUQ+TV3SzRCXmA/8OdDZiLDBIZxVyzXuztPjfLd3BV1PRAQGCMWWSHYhL0F8d5uHBDQ== dependencies: - "@babel/types" "^7.28.0" + "@babel/types" "^7.28.5" "@babel/template@^7.27.2": version "7.27.2" @@ -716,26 +725,26 @@ "@babel/parser" "^7.27.2" "@babel/types" "^7.27.1" -"@babel/traverse@^7.27.1", "@babel/traverse@^7.27.3", "@babel/traverse@^7.28.0": - version "7.28.0" - resolved "https://registry.yarnpkg.com/@babel/traverse/-/traverse-7.28.0.tgz#518aa113359b062042379e333db18380b537e34b" - integrity sha512-mGe7UK5wWyh0bKRfupsUchrQGqvDbZDbKJw+kcRGSmdHVYrv+ltd0pnpDTVpiTqnaBru9iEvA8pz8W46v0Amwg== +"@babel/traverse@^7.27.1", "@babel/traverse@^7.28.3", "@babel/traverse@^7.28.5": + version "7.28.5" + resolved "https://registry.yarnpkg.com/@babel/traverse/-/traverse-7.28.5.tgz#450cab9135d21a7a2ca9d2d35aa05c20e68c360b" + integrity sha512-TCCj4t55U90khlYkVV/0TfkJkAkUg3jZFA3Neb7unZT8CPok7iiRfaX0F+WnqWqt7OxhOn0uBKXCw4lbL8W0aQ== dependencies: "@babel/code-frame" "^7.27.1" - "@babel/generator" "^7.28.0" + "@babel/generator" "^7.28.5" "@babel/helper-globals" "^7.28.0" - "@babel/parser" "^7.28.0" + "@babel/parser" "^7.28.5" "@babel/template" "^7.27.2" - "@babel/types" "^7.28.0" + "@babel/types" "^7.28.5" debug "^4.3.1" -"@babel/types@^7.27.1", "@babel/types@^7.28.0", "@babel/types@^7.28.2": - version "7.28.2" - resolved "https://registry.yarnpkg.com/@babel/types/-/types-7.28.2.tgz#da9db0856a9a88e0a13b019881d7513588cf712b" - integrity sha512-ruv7Ae4J5dUYULmeXw1gmb7rYRz57OWCPM57pHojnLq/3Z1CK2lNSLTCVjxVk1F/TZHwOZZrOWi0ur95BbLxNQ== +"@babel/types@^7.27.1", "@babel/types@^7.28.4", "@babel/types@^7.28.5": + version "7.28.5" + resolved "https://registry.yarnpkg.com/@babel/types/-/types-7.28.5.tgz#10fc405f60897c35f07e85493c932c7b5ca0592b" + integrity sha512-qQ5m48eI/MFLQ5PxQj4PFaprjyCTLI37ElWMmNs0K8Lk3dVeOdNpB3ks8jc7yM5CDmVC73eMVk/trk3fgmrUpA== dependencies: "@babel/helper-string-parser" "^7.27.1" - "@babel/helper-validator-identifier" "^7.27.1" + "@babel/helper-validator-identifier" "^7.28.5" "@es-joy/jsdoccomment@~0.52.0": version "0.52.0" @@ -748,48 +757,52 @@ esquery "^1.6.0" jsdoc-type-pratt-parser "~4.1.0" -"@eslint-community/eslint-utils@^4.2.0", "@eslint-community/eslint-utils@^4.7.0": - version "4.7.0" - resolved "https://registry.yarnpkg.com/@eslint-community/eslint-utils/-/eslint-utils-4.7.0.tgz#607084630c6c033992a082de6e6fbc1a8b52175a" - integrity sha512-dyybb3AcajC7uha6CvhdVRJqaKyn7w2YKqKyAN37NKYgZT36w+iRb0Dymmc5qEJ549c/S31cMMSFd75bteCpCw== +"@eslint-community/eslint-utils@^4.7.0", "@eslint-community/eslint-utils@^4.8.0": + version "4.9.0" + resolved "https://registry.yarnpkg.com/@eslint-community/eslint-utils/-/eslint-utils-4.9.0.tgz#7308df158e064f0dd8b8fdb58aa14fa2a7f913b3" + integrity sha512-ayVFHdtZ+hsq1t2Dy24wCmGXGe4q9Gu3smhLYALJrr473ZH27MsnSL+LKUlimp4BWJqMDMLmPpx/Q9R3OAlL4g== dependencies: eslint-visitor-keys "^3.4.3" "@eslint-community/regexpp@^4.10.0", "@eslint-community/regexpp@^4.12.1": - version "4.12.1" - resolved "https://registry.yarnpkg.com/@eslint-community/regexpp/-/regexpp-4.12.1.tgz#cfc6cffe39df390a3841cde2abccf92eaa7ae0e0" - integrity sha512-CCZCDJuduB9OUkFkY2IgppNZMi2lBQgD2qzwXkEia16cge2pijY/aXi96CJMquDMn3nJdlPV1A5KrJEXwfLNzQ== + version "4.12.2" + resolved "https://registry.yarnpkg.com/@eslint-community/regexpp/-/regexpp-4.12.2.tgz#bccdf615bcf7b6e8db830ec0b8d21c9a25de597b" + integrity sha512-EriSTlt5OC9/7SXkRSCAhfSxxoSUgBm33OH+IkwbdpgoqsSsUg7y3uh+IICI/Qg4BBWr3U2i39RpmycbxMq4ew== "@eslint/compat@^1.3.1": - version "1.3.1" - resolved "https://registry.yarnpkg.com/@eslint/compat/-/compat-1.3.1.tgz#19f62ee48896d38f8eab591bee2a25dd69abc273" - integrity sha512-k8MHony59I5EPic6EQTCNOuPoVBnoYXkP+20xvwFjN7t0qI3ImyvyBgg+hIVPwC8JaxVjjUZld+cLfBLFDLucg== + version "1.4.1" + resolved "https://registry.yarnpkg.com/@eslint/compat/-/compat-1.4.1.tgz#81eaabb3e0b080350582c1a8092a2d355fabf03e" + integrity sha512-cfO82V9zxxGBxcQDr1lfaYB7wykTa0b00mGa36FrJl7iTFd0Z2cHfEYuxcBRP/iNijCsWsEkA+jzT8hGYmv33w== + dependencies: + "@eslint/core" "^0.17.0" -"@eslint/config-array@^0.21.0": - version "0.21.0" - resolved "https://registry.yarnpkg.com/@eslint/config-array/-/config-array-0.21.0.tgz#abdbcbd16b124c638081766392a4d6b509f72636" - integrity sha512-ENIdc4iLu0d93HeYirvKmrzshzofPw6VkZRKQGe9Nv46ZnWUzcF1xV01dcvEg/1wXUR61OmmlSfyeyO7EvjLxQ== +"@eslint/config-array@^0.21.1": + version "0.21.1" + resolved "https://registry.yarnpkg.com/@eslint/config-array/-/config-array-0.21.1.tgz#7d1b0060fea407f8301e932492ba8c18aff29713" + integrity sha512-aw1gNayWpdI/jSYVgzN5pL0cfzU02GT3NBpeT/DXbx1/1x7ZKxFPd9bwrzygx/qiwIQiJ1sw/zD8qY/kRvlGHA== dependencies: - "@eslint/object-schema" "^2.1.6" + "@eslint/object-schema" "^2.1.7" debug "^4.3.1" minimatch "^3.1.2" -"@eslint/config-helpers@^0.3.0": - version "0.3.0" - resolved "https://registry.yarnpkg.com/@eslint/config-helpers/-/config-helpers-0.3.0.tgz#3e09a90dfb87e0005c7694791e58e97077271286" - integrity sha512-ViuymvFmcJi04qdZeDc2whTHryouGcDlaxPqarTD0ZE10ISpxGUVZGZDx4w01upyIynL3iu6IXH2bS1NhclQMw== +"@eslint/config-helpers@^0.4.2": + version "0.4.2" + resolved "https://registry.yarnpkg.com/@eslint/config-helpers/-/config-helpers-0.4.2.tgz#1bd006ceeb7e2e55b2b773ab318d300e1a66aeda" + integrity sha512-gBrxN88gOIf3R7ja5K9slwNayVcZgK6SOUORm2uBzTeIEfeVaIhOpCtTox3P6R7o2jLFwLFTLnC7kU/RGcYEgw== + dependencies: + "@eslint/core" "^0.17.0" -"@eslint/core@^0.15.0", "@eslint/core@^0.15.1": - version "0.15.1" - resolved "https://registry.yarnpkg.com/@eslint/core/-/core-0.15.1.tgz#d530d44209cbfe2f82ef86d6ba08760196dd3b60" - integrity sha512-bkOp+iumZCCbt1K1CmWf0R9pM5yKpDv+ZXtvSyQpudrI9kuFLp+bM2WOPXImuD/ceQuaa8f5pj93Y7zyECIGNA== +"@eslint/core@^0.17.0": + version "0.17.0" + resolved "https://registry.yarnpkg.com/@eslint/core/-/core-0.17.0.tgz#77225820413d9617509da9342190a2019e78761c" + integrity sha512-yL/sLrpmtDaFEiUj1osRP4TI2MDz1AddJL+jZ7KSqvBuliN4xqYY54IfdN8qD8Toa6g1iloph1fxQNkjOxrrpQ== dependencies: "@types/json-schema" "^7.0.15" "@eslint/eslintrc@^3.3.1": - version "3.3.1" - resolved "https://registry.yarnpkg.com/@eslint/eslintrc/-/eslintrc-3.3.1.tgz#e55f7f1dd400600dd066dbba349c4c0bac916964" - integrity sha512-gtF186CXhIl1p4pJNGZw8Yc6RlshoePRvE0X91oPGb3vZ8pM3qOS9W9NGPat9LziaBV7XrJWGylNQXkGcnM3IQ== + version "3.3.3" + resolved "https://registry.yarnpkg.com/@eslint/eslintrc/-/eslintrc-3.3.3.tgz#26393a0806501b5e2b6a43aa588a4d8df67880ac" + integrity sha512-Kr+LPIUVKz2qkx1HAMH8q1q6azbqBAsXJUxBl/ODDuVPX45Z9DfwB8tPjTi6nNZ8BuM3nbJxC5zCAg5elnBUTQ== dependencies: ajv "^6.12.4" debug "^4.3.2" @@ -797,37 +810,37 @@ globals "^14.0.0" ignore "^5.2.0" import-fresh "^3.2.1" - js-yaml "^4.1.0" + js-yaml "^4.1.1" minimatch "^3.1.2" strip-json-comments "^3.1.1" -"@eslint/js@9.32.0", "@eslint/js@^9.32.0": - version "9.32.0" - resolved "https://registry.yarnpkg.com/@eslint/js/-/js-9.32.0.tgz#a02916f58bd587ea276876cb051b579a3d75d091" - integrity sha512-BBpRFZK3eX6uMLKz8WxFOBIFFcGFJ/g8XuwjTHCqHROSIsopI+ddn/d5Cfh36+7+e5edVS8dbSHnBNhrLEX0zg== +"@eslint/js@9.39.1", "@eslint/js@^9.32.0": + version "9.39.1" + resolved "https://registry.yarnpkg.com/@eslint/js/-/js-9.39.1.tgz#0dd59c3a9f40e3f1882975c321470969243e0164" + integrity sha512-S26Stp4zCy88tH94QbBv3XCuzRQiZ9yXofEILmglYTh/Ug/a9/umqvgFtYBAo3Lp0nsI/5/qH1CCrbdK3AP1Tw== -"@eslint/object-schema@^2.1.6": - version "2.1.6" - resolved "https://registry.yarnpkg.com/@eslint/object-schema/-/object-schema-2.1.6.tgz#58369ab5b5b3ca117880c0f6c0b0f32f6950f24f" - integrity sha512-RBMg5FRL0I0gs51M/guSAj5/e14VQ4tpZnQNWwuDT66P14I43ItmPfIZRhO9fUVIPOAQXU47atlywZ/czoqFPA== +"@eslint/object-schema@^2.1.7": + version "2.1.7" + resolved "https://registry.yarnpkg.com/@eslint/object-schema/-/object-schema-2.1.7.tgz#6e2126a1347e86a4dedf8706ec67ff8e107ebbad" + integrity sha512-VtAOaymWVfZcmZbp6E2mympDIHvyjXs/12LqWYjVw6qjrfF+VK+fyG33kChz3nnK+SU5/NeHOqrTEHS8sXO3OA== -"@eslint/plugin-kit@^0.3.4": - version "0.3.4" - resolved "https://registry.yarnpkg.com/@eslint/plugin-kit/-/plugin-kit-0.3.4.tgz#c6b9f165e94bf4d9fdd493f1c028a94aaf5fc1cc" - integrity sha512-Ul5l+lHEcw3L5+k8POx6r74mxEYKG5kOb6Xpy2gCRW6zweT6TEhAf8vhxGgjhqrd/VO/Dirhsb+1hNpD1ue9hw== +"@eslint/plugin-kit@^0.4.1": + version "0.4.1" + resolved "https://registry.yarnpkg.com/@eslint/plugin-kit/-/plugin-kit-0.4.1.tgz#9779e3fd9b7ee33571a57435cf4335a1794a6cb2" + integrity sha512-43/qtrDUokr7LJqoF2c3+RInu/t4zfrpYdoSDfYyhg52rwLV6TnOvdG4fXm7IkSB3wErkcmJS9iEhjVtOSEjjA== dependencies: - "@eslint/core" "^0.15.1" + "@eslint/core" "^0.17.0" levn "^0.4.1" -"@gerrit0/mini-shiki@^3.7.0": - version "3.9.0" - resolved "https://registry.yarnpkg.com/@gerrit0/mini-shiki/-/mini-shiki-3.9.0.tgz#a03e8181f534bb24a854fb2ad8659b30b4dcd983" - integrity sha512-p58r5PE/hIKtE7aYzeDYZr4DPrOidwoUFPX3p6rPEZWtb7zWX3b7Bu9LZ17XODFiRO4x/VzTE15KYNEaZ3khuw== +"@gerrit0/mini-shiki@^3.17.0": + version "3.17.1" + resolved "https://registry.yarnpkg.com/@gerrit0/mini-shiki/-/mini-shiki-3.17.1.tgz#e97e9b780b0c7d4ab8bccd845e6e3a44e0f053ae" + integrity sha512-u7gBnLsvhyVpwR4G8LcSHDlPn8Hg8zNeuzzR4+p2AxvQrQ+BDGo/mLMCpo58VFiIbl8+ie42fqunDclZ4RxNWw== dependencies: - "@shikijs/engine-oniguruma" "^3.9.0" - "@shikijs/langs" "^3.9.0" - "@shikijs/themes" "^3.9.0" - "@shikijs/types" "^3.9.0" + "@shikijs/engine-oniguruma" "^3.17.1" + "@shikijs/langs" "^3.17.1" + "@shikijs/themes" "^3.17.1" + "@shikijs/types" "^3.17.1" "@shikijs/vscode-textmate" "^10.0.2" "@humanfs/core@^0.19.1": @@ -836,24 +849,19 @@ integrity sha512-5DyQ4+1JEUzejeK1JGICcideyfUbGixgS9jNgex5nqkW+cY7WZhxBigmieN5Qnw9ZosSNVC9KQKyb+GUaGyKUA== "@humanfs/node@^0.16.6": - version "0.16.6" - resolved "https://registry.yarnpkg.com/@humanfs/node/-/node-0.16.6.tgz#ee2a10eaabd1131987bf0488fd9b820174cd765e" - integrity sha512-YuI2ZHQL78Q5HbhDiBA1X4LmYdXCKCMQIfw0pw7piHJwyREFebJUvrQN4cMssyES6x+vfUbx1CIpaQUKYdQZOw== + version "0.16.7" + resolved "https://registry.yarnpkg.com/@humanfs/node/-/node-0.16.7.tgz#822cb7b3a12c5a240a24f621b5a2413e27a45f26" + integrity sha512-/zUx+yOsIrG4Y43Eh2peDeKCxlRt/gET6aHfaKpuq267qXdYDFViVHfMaLyygZOnl0kGWxFIgsBy8QFuTLUXEQ== dependencies: "@humanfs/core" "^0.19.1" - "@humanwhocodes/retry" "^0.3.0" + "@humanwhocodes/retry" "^0.4.0" "@humanwhocodes/module-importer@^1.0.1": version "1.0.1" resolved "https://registry.yarnpkg.com/@humanwhocodes/module-importer/-/module-importer-1.0.1.tgz#af5b2691a22b44be847b0ca81641c5fb6ad0172c" integrity sha512-bxveV4V8v5Yb4ncFTT3rPSgZBOpCkjfK0y4oVVVJwIuDVBRMDXrPyXRL988i5ap9m9bnyEEjWfm5WkBmtffLfA== -"@humanwhocodes/retry@^0.3.0": - version "0.3.1" - resolved "https://registry.yarnpkg.com/@humanwhocodes/retry/-/retry-0.3.1.tgz#c72a5c76a9fbaf3488e231b13dc52c0da7bab42a" - integrity sha512-JBxkERygn7Bv/GbN5Rv8Ul6LVknS+5Bp6RgDC/O8gEBU/yeH5Ui5C/OlWrTb6qct7LjjfT6Re2NxB0ln0yYybA== - -"@humanwhocodes/retry@^0.4.2": +"@humanwhocodes/retry@^0.4.0", "@humanwhocodes/retry@^0.4.2": version "0.4.3" resolved "https://registry.yarnpkg.com/@humanwhocodes/retry/-/retry-0.4.3.tgz#c2b9d2e374ee62c586d3adbea87199b1d7a7a6ba" integrity sha512-bV0Tgo9K4hfPCek+aMAn81RppFKv2ySDQeMoSZuvTASywNTnVJCArCZE2FWqpvIatKu7VMRLWlR1EazvVhDyhQ== @@ -863,41 +871,41 @@ resolved "https://registry.yarnpkg.com/@inversifyjs/common/-/common-1.5.2.tgz#6836287fef1c25dddbdf6af345a33a6d6caf6835" integrity sha512-WlzR9xGadABS9gtgZQ+luoZ8V6qm4Ii6RQfcfC9Ho2SOlE6ZuemFo7PKJvKI0ikm8cmKbU8hw5UK6E4qovH21w== -"@inversifyjs/container@1.12.1": - version "1.12.1" - resolved "https://registry.yarnpkg.com/@inversifyjs/container/-/container-1.12.1.tgz#6c1b142365074c5cd8766b0ec90092f02a7cddf4" - integrity sha512-E64SnmsJhbKA6idh/8zJNsBhMX52tjBrlFGfDfrNf63YLjF3hfOXqobWY/6Xln1jGxX79F7Z+WHrn4xNF12lzA== +"@inversifyjs/container@1.14.1": + version "1.14.1" + resolved "https://registry.yarnpkg.com/@inversifyjs/container/-/container-1.14.1.tgz#9ba7b20b3e5e92397346f74cd9f4cb320afb77b3" + integrity sha512-OFSlXXFgEk2zSV4ZCapJeVc0jtN+DxiXB1Szz2AManOFEhFc9uiUFBUJ8XxOy4SuIAYPNNLW55F6owm/birqvg== dependencies: "@inversifyjs/common" "1.5.2" - "@inversifyjs/core" "6.0.1" + "@inversifyjs/core" "9.1.1" "@inversifyjs/plugin" "0.2.0" - "@inversifyjs/reflect-metadata-utils" "1.3.0" + "@inversifyjs/reflect-metadata-utils" "1.4.1" -"@inversifyjs/core@6.0.1": - version "6.0.1" - resolved "https://registry.yarnpkg.com/@inversifyjs/core/-/core-6.0.1.tgz#be7e9ea30b5a94fb33214217066d51f6c797d977" - integrity sha512-i0T9eSdYSZCx9b3izzlC3NIuHV03RQ1vwEa3vXgvk2vPIgW11DqMQefEVmxVx1pQZoS1EOK3ENZfHqZ/omWlzg== +"@inversifyjs/core@9.1.1": + version "9.1.1" + resolved "https://registry.yarnpkg.com/@inversifyjs/core/-/core-9.1.1.tgz#d6df9cdc10d9b01a65036bf9cf94b97e8ff187ab" + integrity sha512-3GNF/a889+Z3AxMZGl5LvBaHYIRvn+rm4b6jec3YncyqNRXoLQjUUAleE0AbVUdUl8YntJ5NW+qe5vjbM0wk/w== dependencies: "@inversifyjs/common" "1.5.2" - "@inversifyjs/prototype-utils" "0.1.2" - "@inversifyjs/reflect-metadata-utils" "1.3.0" + "@inversifyjs/prototype-utils" "0.1.3" + "@inversifyjs/reflect-metadata-utils" "1.4.1" "@inversifyjs/plugin@0.2.0": version "0.2.0" resolved "https://registry.yarnpkg.com/@inversifyjs/plugin/-/plugin-0.2.0.tgz#03957c7d02803f32254a2ff2f8f8ffb05ec57eec" integrity sha512-R/JAdkTSD819pV1zi0HP54mWHyX+H2m8SxldXRgPQarS3ySV4KPyRdosWcfB8Se0JJZWZLHYiUNiS6JvMWSPjw== -"@inversifyjs/prototype-utils@0.1.2": - version "0.1.2" - resolved "https://registry.yarnpkg.com/@inversifyjs/prototype-utils/-/prototype-utils-0.1.2.tgz#2ff5241c2f50772b3202ad5f052b84852eedd8d3" - integrity sha512-WZAEycwVd8zVCPCQ7GRzuQmjYF7X5zbjI9cGigDbBoTHJ8y5US9om00IAp0RYislO+fYkMzgcB2SnlIVIzyESA== +"@inversifyjs/prototype-utils@0.1.3": + version "0.1.3" + resolved "https://registry.yarnpkg.com/@inversifyjs/prototype-utils/-/prototype-utils-0.1.3.tgz#c720e7d2d847e4748534c5986b25e271186898d2" + integrity sha512-EzRamZzNgE9Sn3QtZ8NncNa2lpPMZfspqbK6BWFguWnOpK8ymp2TUuH46ruFHZhrHKnknPd7fG22ZV7iF517TQ== dependencies: "@inversifyjs/common" "1.5.2" -"@inversifyjs/reflect-metadata-utils@1.3.0": - version "1.3.0" - resolved "https://registry.yarnpkg.com/@inversifyjs/reflect-metadata-utils/-/reflect-metadata-utils-1.3.0.tgz#12ba46734120608d16a64fb4ac7b3cc270f19b36" - integrity sha512-JJVnIRq75+nF8FP4WwFPdVQ4sgqf09acXbODi3B7vVtJo+0Mo0YQOOdSWw/cHmbP8+5MAKi4PBYOK3yqn4tGNg== +"@inversifyjs/reflect-metadata-utils@1.4.1": + version "1.4.1" + resolved "https://registry.yarnpkg.com/@inversifyjs/reflect-metadata-utils/-/reflect-metadata-utils-1.4.1.tgz#6219df487e6aab1810a0feee4a625a0e11397340" + integrity sha512-Cp77C4d2wLaHXiUB7iH6Cxb7i1lD/YDuTIHLTDzKINqGSz0DCSoL/Dg2wVkW/6Qx03r/yQMLJ+32Agl32N2X8g== "@istanbuljs/load-nyc-config@^1.0.0": version "1.1.0" @@ -916,83 +924,70 @@ integrity sha512-ZXRY4jNvVgSVQ8DL3LTcakaAtXwTVUxE81hslsyD2AtoXW/wVob10HkOJ1X/pAlcI7D+2YoZKg5do8G/w6RYgA== "@jridgewell/gen-mapping@^0.3.12", "@jridgewell/gen-mapping@^0.3.5": - version "0.3.12" - resolved "https://registry.yarnpkg.com/@jridgewell/gen-mapping/-/gen-mapping-0.3.12.tgz#2234ce26c62889f03db3d7fea43c1932ab3e927b" - integrity sha512-OuLGC46TjB5BbN1dH8JULVVZY4WTdkF7tV9Ys6wLL1rubZnCMstOhNHueU5bLCrnRuDhKPDM4g6sw4Bel5Gzqg== + version "0.3.13" + resolved "https://registry.yarnpkg.com/@jridgewell/gen-mapping/-/gen-mapping-0.3.13.tgz#6342a19f44347518c93e43b1ac69deb3c4656a1f" + integrity sha512-2kkt/7niJ6MgEPxF0bYdQ6etZaA+fQvDcLKckhy1yIQOzaoKjBBjSj63/aLVjYE3qhRt5dvM+uUyfCg6UKCBbA== dependencies: "@jridgewell/sourcemap-codec" "^1.5.0" "@jridgewell/trace-mapping" "^0.3.24" +"@jridgewell/remapping@^2.3.5": + version "2.3.5" + resolved "https://registry.yarnpkg.com/@jridgewell/remapping/-/remapping-2.3.5.tgz#375c476d1972947851ba1e15ae8f123047445aa1" + integrity sha512-LI9u/+laYG4Ds1TDKSJW2YPrIlcVYOwi2fUC6xB43lueCjgxV4lffOCZCtYFiH6TNOX+tQKXx97T4IKHbhyHEQ== + dependencies: + "@jridgewell/gen-mapping" "^0.3.5" + "@jridgewell/trace-mapping" "^0.3.24" + "@jridgewell/resolve-uri@^3.1.0": version "3.1.2" resolved "https://registry.yarnpkg.com/@jridgewell/resolve-uri/-/resolve-uri-3.1.2.tgz#7a0ee601f60f99a20c7c7c5ff0c80388c1189bd6" integrity sha512-bRISgCIjP20/tbWSPWMEi54QVPRZExkuD9lJL+UIxUKtwVJA8wW1Trb1jMs1RFXo1CBTNZ/5hpC9QvmKWdopKw== "@jridgewell/sourcemap-codec@^1.4.14", "@jridgewell/sourcemap-codec@^1.5.0": - version "1.5.4" - resolved "https://registry.yarnpkg.com/@jridgewell/sourcemap-codec/-/sourcemap-codec-1.5.4.tgz#7358043433b2e5da569aa02cbc4c121da3af27d7" - integrity sha512-VT2+G1VQs/9oz078bLrYbecdZKs912zQlkelYpuf+SXF+QvZDYJlbx/LSx+meSAwdDFnF8FVXW92AVjjkVmgFw== + version "1.5.5" + resolved "https://registry.yarnpkg.com/@jridgewell/sourcemap-codec/-/sourcemap-codec-1.5.5.tgz#6912b00d2c631c0d15ce1a7ab57cd657f2a8f8ba" + integrity sha512-cYQ9310grqxueWbl+WuIUIaiUaDcj7WOq5fVhEljNVgRfOUhY9fy2zTvfoqWsnebh8Sl70VScFbICvJnLKB0Og== "@jridgewell/trace-mapping@^0.3.24", "@jridgewell/trace-mapping@^0.3.28": - version "0.3.29" - resolved "https://registry.yarnpkg.com/@jridgewell/trace-mapping/-/trace-mapping-0.3.29.tgz#a58d31eaadaf92c6695680b2e1d464a9b8fbf7fc" - integrity sha512-uw6guiW/gcAGPDhLmd77/6lW8QLeiV5RUTsAX46Db6oLhGaVj4lhnPwb184s1bkc8kdVg/+h988dro8GRDpmYQ== + version "0.3.31" + resolved "https://registry.yarnpkg.com/@jridgewell/trace-mapping/-/trace-mapping-0.3.31.tgz#db15d6781c931f3a251a3dac39501c98a6082fd0" + integrity sha512-zzNR+SdQSDJzc8joaeP8QQoCQr8NuYx2dIIytl1QeBEZHJ9uW6hebsrYgbz8hJwUQao3TWCMtmfV8Nu1twOLAw== dependencies: "@jridgewell/resolve-uri" "^3.1.0" "@jridgewell/sourcemap-codec" "^1.4.14" -"@nodelib/fs.scandir@2.1.5": - version "2.1.5" - resolved "https://registry.yarnpkg.com/@nodelib/fs.scandir/-/fs.scandir-2.1.5.tgz#7619c2eb21b25483f6d167548b4cfd5a7488c3d5" - integrity sha512-vq24Bq3ym5HEQm2NKCr3yXDwjc7vTsEThRDnkp2DK9p1uqLR+DHurm/NOTo0KG7HYHU7eppKZj3MyqYuMBf62g== - dependencies: - "@nodelib/fs.stat" "2.0.5" - run-parallel "^1.1.9" - -"@nodelib/fs.stat@2.0.5", "@nodelib/fs.stat@^2.0.2": - version "2.0.5" - resolved "https://registry.yarnpkg.com/@nodelib/fs.stat/-/fs.stat-2.0.5.tgz#5bd262af94e9d25bd1e71b05deed44876a222e8b" - integrity sha512-RkhPPp2zrqDAQA/2jNhnztcPAlv64XdhIp7a7454A5ovI7Bukxgt7MX7udwAu3zg1DcpPU0rz3VV1SeaqvY4+A== - -"@nodelib/fs.walk@^1.2.3": - version "1.2.8" - resolved "https://registry.yarnpkg.com/@nodelib/fs.walk/-/fs.walk-1.2.8.tgz#e95737e8bb6746ddedf69c556953494f196fe69a" - integrity sha512-oGB+UxlgWcgQkgwo8GcEGwemoTFt3FIO9ababBmaGwXIoBKZ+GTy0pP185beGg7Llih/NSHSV2XAs1lnznocSg== - dependencies: - "@nodelib/fs.scandir" "2.1.5" - fastq "^1.6.0" - "@rtsao/scc@^1.1.0": version "1.1.0" resolved "https://registry.yarnpkg.com/@rtsao/scc/-/scc-1.1.0.tgz#927dd2fae9bc3361403ac2c7a00c32ddce9ad7e8" integrity sha512-zt6OdqaDoOnJ1ZYsCYGt9YmWzDXl4vQdKTyJev62gFhRGKdx7mcT54V9KIjg+d2wi9EXsPvAPKe7i7WjfVWB8g== -"@shikijs/engine-oniguruma@^3.9.0": - version "3.9.1" - resolved "https://registry.yarnpkg.com/@shikijs/engine-oniguruma/-/engine-oniguruma-3.9.1.tgz#f4b67790eaa6d73d84a66e9023fa24428af206ae" - integrity sha512-WPlL/xqviwS3te4unSGGGfflKsuHLMI6tPdNYvgz/IygcBT6UiwDFSzjBKyebwi5GGSlXsjjdoJLIBnAplmEZw== +"@shikijs/engine-oniguruma@^3.17.1": + version "3.18.0" + resolved "https://registry.yarnpkg.com/@shikijs/engine-oniguruma/-/engine-oniguruma-3.18.0.tgz#517a8ad9fc6ae8a45839dc47158abffd95791e5c" + integrity sha512-15+O2iy+nYU/IdiBIExXuK0JJABa/8tdnRDODBmLhdygQ43aCuipN5N9vTfS8jvkMByHMR09b5jtX2la0CCoOA== dependencies: - "@shikijs/types" "3.9.1" + "@shikijs/types" "3.18.0" "@shikijs/vscode-textmate" "^10.0.2" -"@shikijs/langs@^3.9.0": - version "3.9.1" - resolved "https://registry.yarnpkg.com/@shikijs/langs/-/langs-3.9.1.tgz#1ddba7c0ede25c436950f59c86c1ec24ad577999" - integrity sha512-Vyy2Yv9PP3Veh3VSsIvNncOR+O93wFsNYgN2B6cCCJlS7H9SKFYc55edsqernsg8WT/zam1cfB6llJsQWLnVhA== +"@shikijs/langs@^3.17.1": + version "3.18.0" + resolved "https://registry.yarnpkg.com/@shikijs/langs/-/langs-3.18.0.tgz#8a7e16bfa979adebd3c3ac868f17e4e42223ce13" + integrity sha512-Deq7ZoYBtimN0M8pD5RU5TKz7DhUSTPtQOBuJpMxPDDJ+MJ7nT90DEmhDM2V0Nzp6DjfTAd+Z7ibpzr8arWqiA== dependencies: - "@shikijs/types" "3.9.1" + "@shikijs/types" "3.18.0" -"@shikijs/themes@^3.9.0": - version "3.9.1" - resolved "https://registry.yarnpkg.com/@shikijs/themes/-/themes-3.9.1.tgz#dc6e733d6c24a03119574a8f01d77b4db5d0e9e5" - integrity sha512-zAykkGECNICCMXpKeVvq04yqwaSuAIvrf8MjsU5bzskfg4XreU+O0B5wdNCYRixoB9snd3YlZ373WV5E/g5T9A== +"@shikijs/themes@^3.17.1": + version "3.18.0" + resolved "https://registry.yarnpkg.com/@shikijs/themes/-/themes-3.18.0.tgz#12afd9faecf58ca05ba776703e1dc53fb3cd65f9" + integrity sha512-wzg6vNniXC5J4ChNBJJIZFTWxmrERJMWknehmM++0OAKJqZ41WpnO7PmPOumvMsUaL1SC08Nb/JVdaJd2aTsZg== dependencies: - "@shikijs/types" "3.9.1" + "@shikijs/types" "3.18.0" -"@shikijs/types@3.9.1", "@shikijs/types@^3.9.0": - version "3.9.1" - resolved "https://registry.yarnpkg.com/@shikijs/types/-/types-3.9.1.tgz#88af89be81ea26e6aa7bf9662f5e9d69a699d636" - integrity sha512-rqM3T7a0iM1oPKz9iaH/cVgNX9Vz1HERcUcXJ94/fulgVdwqfnhXzGxO4bLrAnh/o5CPLy3IcYedogfV+Ns0Qg== +"@shikijs/types@3.18.0", "@shikijs/types@^3.17.1": + version "3.18.0" + resolved "https://registry.yarnpkg.com/@shikijs/types/-/types-3.18.0.tgz#752106c19af9eac63311fe6c93b2d40e9ca0450b" + integrity sha512-YLmpuroH06TpvqRXKR0YqlI0nQ56c8+BO/m9A9ht36WRdxmML4ivUsnpXuJU7PiClLRD2M66ilY2YJ0KE+8q7A== dependencies: "@shikijs/vscode-textmate" "^10.0.2" "@types/hast" "^3.0.4" @@ -1002,157 +997,159 @@ resolved "https://registry.yarnpkg.com/@shikijs/vscode-textmate/-/vscode-textmate-10.0.2.tgz#a90ab31d0cc1dfb54c66a69e515bf624fa7b2224" integrity sha512-83yeghZ2xxin3Nj8z1NMd/NCuca+gsYXswywDy5bHvwlWL8tpTQmzGeUuHd9FC3E/SBEMvzJRwWEOz5gGes9Qg== -"@smithy/abort-controller@^4.0.4": - version "4.0.4" - resolved "https://registry.yarnpkg.com/@smithy/abort-controller/-/abort-controller-4.0.4.tgz#ab991d521fc78b5c7f24907fcd6803c0f2da51d9" - integrity sha512-gJnEjZMvigPDQWHrW3oPrFhQtkrgqBkyjj3pCIdF3A5M6vsZODG93KNlfJprv6bp4245bdT32fsHK4kkH3KYDA== +"@smithy/abort-controller@^4.2.5": + version "4.2.5" + resolved "https://registry.yarnpkg.com/@smithy/abort-controller/-/abort-controller-4.2.5.tgz#3386e8fff5a8d05930996d891d06803f2b7e5e2c" + integrity sha512-j7HwVkBw68YW8UmFRcjZOmssE77Rvk0GWAIN1oFBhsaovQmZWYCIcGa9/pwRB0ExI8Sk9MWNALTjftjHZea7VA== dependencies: - "@smithy/types" "^4.3.1" + "@smithy/types" "^4.9.0" tslib "^2.6.2" -"@smithy/chunked-blob-reader-native@^4.0.0": - version "4.0.0" - resolved "https://registry.yarnpkg.com/@smithy/chunked-blob-reader-native/-/chunked-blob-reader-native-4.0.0.tgz#33cbba6deb8a3c516f98444f65061784f7cd7f8c" - integrity sha512-R9wM2yPmfEMsUmlMlIgSzOyICs0x9uu7UTHoccMyt7BWw8shcGM8HqB355+BZCPBcySvbTYMs62EgEQkNxz2ig== +"@smithy/chunked-blob-reader-native@^4.2.1": + version "4.2.1" + resolved "https://registry.yarnpkg.com/@smithy/chunked-blob-reader-native/-/chunked-blob-reader-native-4.2.1.tgz#380266951d746b522b4ab2b16bfea6b451147b41" + integrity sha512-lX9Ay+6LisTfpLid2zZtIhSEjHMZoAR5hHCR4H7tBz/Zkfr5ea8RcQ7Tk4mi0P76p4cN+Btz16Ffno7YHpKXnQ== dependencies: - "@smithy/util-base64" "^4.0.0" + "@smithy/util-base64" "^4.3.0" tslib "^2.6.2" -"@smithy/chunked-blob-reader@^5.0.0": - version "5.0.0" - resolved "https://registry.yarnpkg.com/@smithy/chunked-blob-reader/-/chunked-blob-reader-5.0.0.tgz#3f6ea5ff4e2b2eacf74cefd737aa0ba869b2e0f6" - integrity sha512-+sKqDBQqb036hh4NPaUiEkYFkTUGYzRsn3EuFhyfQfMy6oGHEUJDurLP9Ufb5dasr/XiAmPNMr6wa9afjQB+Gw== +"@smithy/chunked-blob-reader@^5.2.0": + version "5.2.0" + resolved "https://registry.yarnpkg.com/@smithy/chunked-blob-reader/-/chunked-blob-reader-5.2.0.tgz#776fec5eaa5ab5fa70d0d0174b7402420b24559c" + integrity sha512-WmU0TnhEAJLWvfSeMxBNe5xtbselEO8+4wG0NtZeL8oR21WgH1xiO37El+/Y+H/Ie4SCwBy3MxYWmOYaGgZueA== dependencies: tslib "^2.6.2" -"@smithy/config-resolver@^4.1.4": - version "4.1.4" - resolved "https://registry.yarnpkg.com/@smithy/config-resolver/-/config-resolver-4.1.4.tgz#05d8eab8bb8eb73bec90c222fc19ac5608b1384e" - integrity sha512-prmU+rDddxHOH0oNcwemL+SwnzcG65sBF2yXRO7aeXIn/xTlq2pX7JLVbkBnVLowHLg4/OL4+jBmv9hVrVGS+w== +"@smithy/config-resolver@^4.4.3": + version "4.4.3" + resolved "https://registry.yarnpkg.com/@smithy/config-resolver/-/config-resolver-4.4.3.tgz#37b0e3cba827272e92612e998a2b17e841e20bab" + integrity sha512-ezHLe1tKLUxDJo2LHtDuEDyWXolw8WGOR92qb4bQdWq/zKenO5BvctZGrVJBK08zjezSk7bmbKFOXIVyChvDLw== dependencies: - "@smithy/node-config-provider" "^4.1.3" - "@smithy/types" "^4.3.1" - "@smithy/util-config-provider" "^4.0.0" - "@smithy/util-middleware" "^4.0.4" + "@smithy/node-config-provider" "^4.3.5" + "@smithy/types" "^4.9.0" + "@smithy/util-config-provider" "^4.2.0" + "@smithy/util-endpoints" "^3.2.5" + "@smithy/util-middleware" "^4.2.5" tslib "^2.6.2" -"@smithy/core@^3.7.2": - version "3.7.2" - resolved "https://registry.yarnpkg.com/@smithy/core/-/core-3.7.2.tgz#ae21591dbb983df7d986cc984123cf43f64e3a5a" - integrity sha512-JoLw59sT5Bm8SAjFCYZyuCGxK8y3vovmoVbZWLDPTH5XpPEIwpFd9m90jjVMwoypDuB/SdVgje5Y4T7w50lJaw== - dependencies: - "@smithy/middleware-serde" "^4.0.8" - "@smithy/protocol-http" "^5.1.2" - "@smithy/types" "^4.3.1" - "@smithy/util-base64" "^4.0.0" - "@smithy/util-body-length-browser" "^4.0.0" - "@smithy/util-middleware" "^4.0.4" - "@smithy/util-stream" "^4.2.3" - "@smithy/util-utf8" "^4.0.0" +"@smithy/core@^3.18.5", "@smithy/core@^3.18.6": + version "3.18.6" + resolved "https://registry.yarnpkg.com/@smithy/core/-/core-3.18.6.tgz#bbc0d2dce4b926ce9348bce82b85f5e1294834df" + integrity sha512-8Q/ugWqfDUEU1Exw71+DoOzlONJ2Cn9QA8VeeDzLLjzO/qruh9UKFzbszy4jXcIYgGofxYiT0t1TT6+CT/GupQ== + dependencies: + "@smithy/middleware-serde" "^4.2.6" + "@smithy/protocol-http" "^5.3.5" + "@smithy/types" "^4.9.0" + "@smithy/util-base64" "^4.3.0" + "@smithy/util-body-length-browser" "^4.2.0" + "@smithy/util-middleware" "^4.2.5" + "@smithy/util-stream" "^4.5.6" + "@smithy/util-utf8" "^4.2.0" + "@smithy/uuid" "^1.1.0" tslib "^2.6.2" -"@smithy/credential-provider-imds@^4.0.6": - version "4.0.6" - resolved "https://registry.yarnpkg.com/@smithy/credential-provider-imds/-/credential-provider-imds-4.0.6.tgz#4cfd79a619cdbc9a75fcdc51a1193685f6a8944e" - integrity sha512-hKMWcANhUiNbCJouYkZ9V3+/Qf9pteR1dnwgdyzR09R4ODEYx8BbUysHwRSyex4rZ9zapddZhLFTnT4ZijR4pw== +"@smithy/credential-provider-imds@^4.2.5": + version "4.2.5" + resolved "https://registry.yarnpkg.com/@smithy/credential-provider-imds/-/credential-provider-imds-4.2.5.tgz#5acbcd1d02ae31700c2f027090c202d7315d70d3" + integrity sha512-BZwotjoZWn9+36nimwm/OLIcVe+KYRwzMjfhd4QT7QxPm9WY0HiOV8t/Wlh+HVUif0SBVV7ksq8//hPaBC/okQ== dependencies: - "@smithy/node-config-provider" "^4.1.3" - "@smithy/property-provider" "^4.0.4" - "@smithy/types" "^4.3.1" - "@smithy/url-parser" "^4.0.4" + "@smithy/node-config-provider" "^4.3.5" + "@smithy/property-provider" "^4.2.5" + "@smithy/types" "^4.9.0" + "@smithy/url-parser" "^4.2.5" tslib "^2.6.2" -"@smithy/eventstream-codec@^4.0.4": - version "4.0.4" - resolved "https://registry.yarnpkg.com/@smithy/eventstream-codec/-/eventstream-codec-4.0.4.tgz#35abc26d6829cc61a0d14950857ccc5320bf92d2" - integrity sha512-7XoWfZqWb/QoR/rAU4VSi0mWnO2vu9/ltS6JZ5ZSZv0eovLVfDfu0/AX4ub33RsJTOth3TiFWSHS5YdztvFnig== +"@smithy/eventstream-codec@^4.2.5": + version "4.2.5" + resolved "https://registry.yarnpkg.com/@smithy/eventstream-codec/-/eventstream-codec-4.2.5.tgz#331b3f23528137cb5f4ad861de7f34ddff68c62b" + integrity sha512-Ogt4Zi9hEbIP17oQMd68qYOHUzmH47UkK7q7Gl55iIm9oKt27MUGrC5JfpMroeHjdkOliOA4Qt3NQ1xMq/nrlA== dependencies: "@aws-crypto/crc32" "5.2.0" - "@smithy/types" "^4.3.1" - "@smithy/util-hex-encoding" "^4.0.0" + "@smithy/types" "^4.9.0" + "@smithy/util-hex-encoding" "^4.2.0" tslib "^2.6.2" -"@smithy/eventstream-serde-browser@^4.0.4": - version "4.0.4" - resolved "https://registry.yarnpkg.com/@smithy/eventstream-serde-browser/-/eventstream-serde-browser-4.0.4.tgz#0c57cf0b66862106100a796751003733ce3f5273" - integrity sha512-3fb/9SYaYqbpy/z/H3yIi0bYKyAa89y6xPmIqwr2vQiUT2St+avRt8UKwsWt9fEdEasc5d/V+QjrviRaX1JRFA== +"@smithy/eventstream-serde-browser@^4.2.5": + version "4.2.5" + resolved "https://registry.yarnpkg.com/@smithy/eventstream-serde-browser/-/eventstream-serde-browser-4.2.5.tgz#54a680006539601ce71306d8bf2946e3462a47b3" + integrity sha512-HohfmCQZjppVnKX2PnXlf47CW3j92Ki6T/vkAT2DhBR47e89pen3s4fIa7otGTtrVxmj7q+IhH0RnC5kpR8wtw== dependencies: - "@smithy/eventstream-serde-universal" "^4.0.4" - "@smithy/types" "^4.3.1" + "@smithy/eventstream-serde-universal" "^4.2.5" + "@smithy/types" "^4.9.0" tslib "^2.6.2" -"@smithy/eventstream-serde-config-resolver@^4.1.2": - version "4.1.2" - resolved "https://registry.yarnpkg.com/@smithy/eventstream-serde-config-resolver/-/eventstream-serde-config-resolver-4.1.2.tgz#4d41c1ecad1a9b1c694f32865a2f0d4b5bc0162d" - integrity sha512-JGtambizrWP50xHgbzZI04IWU7LdI0nh/wGbqH3sJesYToMi2j/DcoElqyOcqEIG/D4tNyxgRuaqBXWE3zOFhQ== +"@smithy/eventstream-serde-config-resolver@^4.3.5": + version "4.3.5" + resolved "https://registry.yarnpkg.com/@smithy/eventstream-serde-config-resolver/-/eventstream-serde-config-resolver-4.3.5.tgz#d1490aa127f43ac242495fa6e2e5833e1949a481" + integrity sha512-ibjQjM7wEXtECiT6my1xfiMH9IcEczMOS6xiCQXoUIYSj5b1CpBbJ3VYbdwDy8Vcg5JHN7eFpOCGk8nyZAltNQ== dependencies: - "@smithy/types" "^4.3.1" + "@smithy/types" "^4.9.0" tslib "^2.6.2" -"@smithy/eventstream-serde-node@^4.0.4": - version "4.0.4" - resolved "https://registry.yarnpkg.com/@smithy/eventstream-serde-node/-/eventstream-serde-node-4.0.4.tgz#0fbd0ac288f02bf485eb307a14254ea8d8767746" - integrity sha512-RD6UwNZ5zISpOWPuhVgRz60GkSIp0dy1fuZmj4RYmqLVRtejFqQ16WmfYDdoSoAjlp1LX+FnZo+/hkdmyyGZ1w== +"@smithy/eventstream-serde-node@^4.2.5": + version "4.2.5" + resolved "https://registry.yarnpkg.com/@smithy/eventstream-serde-node/-/eventstream-serde-node-4.2.5.tgz#7dd64e0ba64fa930959f3d5b7995c310573ecaf3" + integrity sha512-+elOuaYx6F2H6x1/5BQP5ugv12nfJl66GhxON8+dWVUEDJ9jah/A0tayVdkLRP0AeSac0inYkDz5qBFKfVp2Gg== dependencies: - "@smithy/eventstream-serde-universal" "^4.0.4" - "@smithy/types" "^4.3.1" + "@smithy/eventstream-serde-universal" "^4.2.5" + "@smithy/types" "^4.9.0" tslib "^2.6.2" -"@smithy/eventstream-serde-universal@^4.0.4": - version "4.0.4" - resolved "https://registry.yarnpkg.com/@smithy/eventstream-serde-universal/-/eventstream-serde-universal-4.0.4.tgz#48b2b416dc0f576917c36373efaa4012f7310ab0" - integrity sha512-UeJpOmLGhq1SLox79QWw/0n2PFX+oPRE1ZyRMxPIaFEfCqWaqpB7BU9C8kpPOGEhLF7AwEqfFbtwNxGy4ReENA== +"@smithy/eventstream-serde-universal@^4.2.5": + version "4.2.5" + resolved "https://registry.yarnpkg.com/@smithy/eventstream-serde-universal/-/eventstream-serde-universal-4.2.5.tgz#34189de45cf5e1d9cb59978e94b76cc210fa984f" + integrity sha512-G9WSqbST45bmIFaeNuP/EnC19Rhp54CcVdX9PDL1zyEB514WsDVXhlyihKlGXnRycmHNmVv88Bvvt4EYxWef/Q== dependencies: - "@smithy/eventstream-codec" "^4.0.4" - "@smithy/types" "^4.3.1" + "@smithy/eventstream-codec" "^4.2.5" + "@smithy/types" "^4.9.0" tslib "^2.6.2" -"@smithy/fetch-http-handler@^5.1.0": - version "5.1.0" - resolved "https://registry.yarnpkg.com/@smithy/fetch-http-handler/-/fetch-http-handler-5.1.0.tgz#387abd9ec6c8ff0af33b268c0f6ccb289c1b1563" - integrity sha512-mADw7MS0bYe2OGKkHYMaqarOXuDwRbO6ArD91XhHcl2ynjGCFF+hvqf0LyQcYxkA1zaWjefSkU7Ne9mqgApSgQ== +"@smithy/fetch-http-handler@^5.3.6": + version "5.3.6" + resolved "https://registry.yarnpkg.com/@smithy/fetch-http-handler/-/fetch-http-handler-5.3.6.tgz#d9dcb8d8ca152918224492f4d1cc1b50df93ae13" + integrity sha512-3+RG3EA6BBJ/ofZUeTFJA7mHfSYrZtQIrDP9dI8Lf7X6Jbos2jptuLrAAteDiFVrmbEmLSuRG/bUKzfAXk7dhg== dependencies: - "@smithy/protocol-http" "^5.1.2" - "@smithy/querystring-builder" "^4.0.4" - "@smithy/types" "^4.3.1" - "@smithy/util-base64" "^4.0.0" + "@smithy/protocol-http" "^5.3.5" + "@smithy/querystring-builder" "^4.2.5" + "@smithy/types" "^4.9.0" + "@smithy/util-base64" "^4.3.0" tslib "^2.6.2" -"@smithy/hash-blob-browser@^4.0.4": - version "4.0.4" - resolved "https://registry.yarnpkg.com/@smithy/hash-blob-browser/-/hash-blob-browser-4.0.4.tgz#34adda037d324123d77032b3ad59c16e6d4949bb" - integrity sha512-WszRiACJiQV3QG6XMV44i5YWlkrlsM5Yxgz4jvsksuu7LDXA6wAtypfPajtNTadzpJy3KyJPoWehYpmZGKUFIQ== +"@smithy/hash-blob-browser@^4.2.6": + version "4.2.6" + resolved "https://registry.yarnpkg.com/@smithy/hash-blob-browser/-/hash-blob-browser-4.2.6.tgz#53d5ae0a069ae4a93abbc7165efe341dca0f9489" + integrity sha512-8P//tA8DVPk+3XURk2rwcKgYwFvwGwmJH/wJqQiSKwXZtf/LiZK+hbUZmPj/9KzM+OVSwe4o85KTp5x9DUZTjw== dependencies: - "@smithy/chunked-blob-reader" "^5.0.0" - "@smithy/chunked-blob-reader-native" "^4.0.0" - "@smithy/types" "^4.3.1" + "@smithy/chunked-blob-reader" "^5.2.0" + "@smithy/chunked-blob-reader-native" "^4.2.1" + "@smithy/types" "^4.9.0" tslib "^2.6.2" -"@smithy/hash-node@^4.0.4": - version "4.0.4" - resolved "https://registry.yarnpkg.com/@smithy/hash-node/-/hash-node-4.0.4.tgz#f867cfe6b702ed8893aacd3e097f8ca8ecba579e" - integrity sha512-qnbTPUhCVnCgBp4z4BUJUhOEkVwxiEi1cyFM+Zj6o+aY8OFGxUQleKWq8ltgp3dujuhXojIvJWdoqpm6dVO3lQ== +"@smithy/hash-node@^4.2.5": + version "4.2.5" + resolved "https://registry.yarnpkg.com/@smithy/hash-node/-/hash-node-4.2.5.tgz#fb751ec4a4c6347612458430f201f878adc787f6" + integrity sha512-DpYX914YOfA3UDT9CN1BM787PcHfWRBB43fFGCYrZFUH0Jv+5t8yYl+Pd5PW4+QzoGEDvn5d5QIO4j2HyYZQSA== dependencies: - "@smithy/types" "^4.3.1" - "@smithy/util-buffer-from" "^4.0.0" - "@smithy/util-utf8" "^4.0.0" + "@smithy/types" "^4.9.0" + "@smithy/util-buffer-from" "^4.2.0" + "@smithy/util-utf8" "^4.2.0" tslib "^2.6.2" -"@smithy/hash-stream-node@^4.0.4": - version "4.0.4" - resolved "https://registry.yarnpkg.com/@smithy/hash-stream-node/-/hash-stream-node-4.0.4.tgz#02c023590e09529e940e0a0243d32c02c4e6c645" - integrity sha512-wHo0d8GXyVmpmMh/qOR0R7Y46/G1y6OR8U+bSTB4ppEzRxd1xVAQ9xOE9hOc0bSjhz0ujCPAbfNLkLrpa6cevg== +"@smithy/hash-stream-node@^4.2.5": + version "4.2.5" + resolved "https://registry.yarnpkg.com/@smithy/hash-stream-node/-/hash-stream-node-4.2.5.tgz#f200e6b755cb28f03968c199231774c3ad33db28" + integrity sha512-6+do24VnEyvWcGdHXomlpd0m8bfZePpUKBy7m311n+JuRwug8J4dCanJdTymx//8mi0nlkflZBvJe+dEO/O12Q== dependencies: - "@smithy/types" "^4.3.1" - "@smithy/util-utf8" "^4.0.0" + "@smithy/types" "^4.9.0" + "@smithy/util-utf8" "^4.2.0" tslib "^2.6.2" -"@smithy/invalid-dependency@^4.0.4": - version "4.0.4" - resolved "https://registry.yarnpkg.com/@smithy/invalid-dependency/-/invalid-dependency-4.0.4.tgz#8c2c539b2f22e857b4652bd2427a3d7a8befd610" - integrity sha512-bNYMi7WKTJHu0gn26wg8OscncTt1t2b8KcsZxvOv56XA6cyXtOAAAaNP7+m45xfppXfOatXF3Sb1MNsLUgVLTw== +"@smithy/invalid-dependency@^4.2.5": + version "4.2.5" + resolved "https://registry.yarnpkg.com/@smithy/invalid-dependency/-/invalid-dependency-4.2.5.tgz#58d997e91e7683ffc59882d8fcb180ed9aa9c7dd" + integrity sha512-2L2erASEro1WC5nV+plwIMxrTXpvpfzl4e+Nre6vBVRR2HKeGGcvpJyyL3/PpiSg+cJG2KpTmZmq934Olb6e5A== dependencies: - "@smithy/types" "^4.3.1" + "@smithy/types" "^4.9.0" tslib "^2.6.2" "@smithy/is-array-buffer@^2.2.0": @@ -1162,209 +1159,209 @@ dependencies: tslib "^2.6.2" -"@smithy/is-array-buffer@^4.0.0": - version "4.0.0" - resolved "https://registry.yarnpkg.com/@smithy/is-array-buffer/-/is-array-buffer-4.0.0.tgz#55a939029321fec462bcc574890075cd63e94206" - integrity sha512-saYhF8ZZNoJDTvJBEWgeBccCg+yvp1CX+ed12yORU3NilJScfc6gfch2oVb4QgxZrGUx3/ZJlb+c/dJbyupxlw== +"@smithy/is-array-buffer@^4.2.0": + version "4.2.0" + resolved "https://registry.yarnpkg.com/@smithy/is-array-buffer/-/is-array-buffer-4.2.0.tgz#b0f874c43887d3ad44f472a0f3f961bcce0550c2" + integrity sha512-DZZZBvC7sjcYh4MazJSGiWMI2L7E0oCiRHREDzIxi/M2LY79/21iXt6aPLHge82wi5LsuRF5A06Ds3+0mlh6CQ== dependencies: tslib "^2.6.2" -"@smithy/md5-js@^4.0.4": - version "4.0.4" - resolved "https://registry.yarnpkg.com/@smithy/md5-js/-/md5-js-4.0.4.tgz#d7cb70b08c2a4d809d5cb905feab74fc9726a2f2" - integrity sha512-uGLBVqcOwrLvGh/v/jw423yWHq/ofUGK1W31M2TNspLQbUV1Va0F5kTxtirkoHawODAZcjXTSGi7JwbnPcDPJg== +"@smithy/md5-js@^4.2.5": + version "4.2.5" + resolved "https://registry.yarnpkg.com/@smithy/md5-js/-/md5-js-4.2.5.tgz#ca16f138dd0c4e91a61d3df57e8d4d15d1ddc97e" + integrity sha512-Bt6jpSTMWfjCtC0s79gZ/WZ1w90grfmopVOWqkI2ovhjpD5Q2XRXuecIPB9689L2+cCySMbaXDhBPU56FKNDNg== dependencies: - "@smithy/types" "^4.3.1" - "@smithy/util-utf8" "^4.0.0" + "@smithy/types" "^4.9.0" + "@smithy/util-utf8" "^4.2.0" tslib "^2.6.2" -"@smithy/middleware-content-length@^4.0.4": - version "4.0.4" - resolved "https://registry.yarnpkg.com/@smithy/middleware-content-length/-/middleware-content-length-4.0.4.tgz#fad1f125779daf8d5f261dae6dbebba0f60c234b" - integrity sha512-F7gDyfI2BB1Kc+4M6rpuOLne5LOcEknH1n6UQB69qv+HucXBR1rkzXBnQTB2q46sFy1PM/zuSJOB532yc8bg3w== +"@smithy/middleware-content-length@^4.2.5": + version "4.2.5" + resolved "https://registry.yarnpkg.com/@smithy/middleware-content-length/-/middleware-content-length-4.2.5.tgz#a6942ce2d7513b46f863348c6c6a8177e9ace752" + integrity sha512-Y/RabVa5vbl5FuHYV2vUCwvh/dqzrEY/K2yWPSqvhFUwIY0atLqO4TienjBXakoy4zrKAMCZwg+YEqmH7jaN7A== dependencies: - "@smithy/protocol-http" "^5.1.2" - "@smithy/types" "^4.3.1" + "@smithy/protocol-http" "^5.3.5" + "@smithy/types" "^4.9.0" tslib "^2.6.2" -"@smithy/middleware-endpoint@^4.1.17": - version "4.1.17" - resolved "https://registry.yarnpkg.com/@smithy/middleware-endpoint/-/middleware-endpoint-4.1.17.tgz#d6a87ccf5fe6a6edc5fe01832338854feaf18a12" - integrity sha512-S3hSGLKmHG1m35p/MObQCBCdRsrpbPU8B129BVzRqRfDvQqPMQ14iO4LyRw+7LNizYc605COYAcjqgawqi+6jA== - dependencies: - "@smithy/core" "^3.7.2" - "@smithy/middleware-serde" "^4.0.8" - "@smithy/node-config-provider" "^4.1.3" - "@smithy/shared-ini-file-loader" "^4.0.4" - "@smithy/types" "^4.3.1" - "@smithy/url-parser" "^4.0.4" - "@smithy/util-middleware" "^4.0.4" +"@smithy/middleware-endpoint@^4.3.12", "@smithy/middleware-endpoint@^4.3.13": + version "4.3.13" + resolved "https://registry.yarnpkg.com/@smithy/middleware-endpoint/-/middleware-endpoint-4.3.13.tgz#94a0e9fd360355bd224481b5371b39dd3f8e9c99" + integrity sha512-X4za1qCdyx1hEVVXuAWlZuK6wzLDv1uw1OY9VtaYy1lULl661+frY7FeuHdYdl7qAARUxH2yvNExU2/SmRFfcg== + dependencies: + "@smithy/core" "^3.18.6" + "@smithy/middleware-serde" "^4.2.6" + "@smithy/node-config-provider" "^4.3.5" + "@smithy/shared-ini-file-loader" "^4.4.0" + "@smithy/types" "^4.9.0" + "@smithy/url-parser" "^4.2.5" + "@smithy/util-middleware" "^4.2.5" tslib "^2.6.2" -"@smithy/middleware-retry@^4.1.18": - version "4.1.18" - resolved "https://registry.yarnpkg.com/@smithy/middleware-retry/-/middleware-retry-4.1.18.tgz#4d57587722c341822cf8c58790f843008fef0f8e" - integrity sha512-bYLZ4DkoxSsPxpdmeapvAKy7rM5+25gR7PGxq2iMiecmbrRGBHj9s75N74Ylg+aBiw9i5jIowC/cLU2NR0qH8w== - dependencies: - "@smithy/node-config-provider" "^4.1.3" - "@smithy/protocol-http" "^5.1.2" - "@smithy/service-error-classification" "^4.0.6" - "@smithy/smithy-client" "^4.4.9" - "@smithy/types" "^4.3.1" - "@smithy/util-middleware" "^4.0.4" - "@smithy/util-retry" "^4.0.6" +"@smithy/middleware-retry@^4.4.12": + version "4.4.13" + resolved "https://registry.yarnpkg.com/@smithy/middleware-retry/-/middleware-retry-4.4.13.tgz#1038ddb69d43301e6424eb1122dd090f3789d8a2" + integrity sha512-RzIDF9OrSviXX7MQeKOm8r/372KTyY8Jmp6HNKOOYlrguHADuM3ED/f4aCyNhZZFLG55lv5beBin7nL0Nzy1Dw== + dependencies: + "@smithy/node-config-provider" "^4.3.5" + "@smithy/protocol-http" "^5.3.5" + "@smithy/service-error-classification" "^4.2.5" + "@smithy/smithy-client" "^4.9.9" + "@smithy/types" "^4.9.0" + "@smithy/util-middleware" "^4.2.5" + "@smithy/util-retry" "^4.2.5" + "@smithy/uuid" "^1.1.0" tslib "^2.6.2" - uuid "^9.0.1" -"@smithy/middleware-serde@^4.0.8": - version "4.0.8" - resolved "https://registry.yarnpkg.com/@smithy/middleware-serde/-/middleware-serde-4.0.8.tgz#3704c8cc46acd0a7f910a78ee1d2f23ce928701f" - integrity sha512-iSSl7HJoJaGyMIoNn2B7czghOVwJ9nD7TMvLhMWeSB5vt0TnEYyRRqPJu/TqW76WScaNvYYB8nRoiBHR9S1Ddw== +"@smithy/middleware-serde@^4.2.6": + version "4.2.6" + resolved "https://registry.yarnpkg.com/@smithy/middleware-serde/-/middleware-serde-4.2.6.tgz#7e710f43206e13a8c081a372b276e7b2c51bff5b" + integrity sha512-VkLoE/z7e2g8pirwisLz8XJWedUSY8my/qrp81VmAdyrhi94T+riBfwP+AOEEFR9rFTSonC/5D2eWNmFabHyGQ== dependencies: - "@smithy/protocol-http" "^5.1.2" - "@smithy/types" "^4.3.1" + "@smithy/protocol-http" "^5.3.5" + "@smithy/types" "^4.9.0" tslib "^2.6.2" -"@smithy/middleware-stack@^4.0.4": - version "4.0.4" - resolved "https://registry.yarnpkg.com/@smithy/middleware-stack/-/middleware-stack-4.0.4.tgz#58e0c6a0d7678c6ad4d6af8dd9a00f749ffac7c5" - integrity sha512-kagK5ggDrBUCCzI93ft6DjteNSfY8Ulr83UtySog/h09lTIOAJ/xUSObutanlPT0nhoHAkpmW9V5K8oPyLh+QA== +"@smithy/middleware-stack@^4.2.5": + version "4.2.5" + resolved "https://registry.yarnpkg.com/@smithy/middleware-stack/-/middleware-stack-4.2.5.tgz#2d13415ed3561c882594c8e6340b801d9a2eb222" + integrity sha512-bYrutc+neOyWxtZdbB2USbQttZN0mXaOyYLIsaTbJhFsfpXyGWUxJpEuO1rJ8IIJm2qH4+xJT0mxUSsEDTYwdQ== dependencies: - "@smithy/types" "^4.3.1" + "@smithy/types" "^4.9.0" tslib "^2.6.2" -"@smithy/node-config-provider@^4.1.3": - version "4.1.3" - resolved "https://registry.yarnpkg.com/@smithy/node-config-provider/-/node-config-provider-4.1.3.tgz#6626fe26c6fe7b0df34f71cb72764ccba414a815" - integrity sha512-HGHQr2s59qaU1lrVH6MbLlmOBxadtzTsoO4c+bF5asdgVik3I8o7JIOzoeqWc5MjVa+vD36/LWE0iXKpNqooRw== +"@smithy/node-config-provider@^4.3.5": + version "4.3.5" + resolved "https://registry.yarnpkg.com/@smithy/node-config-provider/-/node-config-provider-4.3.5.tgz#c09137a79c2930dcc30e6c8bb4f2608d72c1e2c9" + integrity sha512-UTurh1C4qkVCtqggI36DGbLB2Kv8UlcFdMXDcWMbqVY2uRg0XmT9Pb4Vj6oSQ34eizO1fvR0RnFV4Axw4IrrAg== dependencies: - "@smithy/property-provider" "^4.0.4" - "@smithy/shared-ini-file-loader" "^4.0.4" - "@smithy/types" "^4.3.1" + "@smithy/property-provider" "^4.2.5" + "@smithy/shared-ini-file-loader" "^4.4.0" + "@smithy/types" "^4.9.0" tslib "^2.6.2" -"@smithy/node-http-handler@^4.1.0": - version "4.1.0" - resolved "https://registry.yarnpkg.com/@smithy/node-http-handler/-/node-http-handler-4.1.0.tgz#6b528cd0da0c35755b34afba207b7db972b0eb92" - integrity sha512-vqfSiHz2v8b3TTTrdXi03vNz1KLYYS3bhHCDv36FYDqxT7jvTll1mMnCrkD+gOvgwybuunh/2VmvOMqwBegxEg== +"@smithy/node-http-handler@^4.4.5": + version "4.4.5" + resolved "https://registry.yarnpkg.com/@smithy/node-http-handler/-/node-http-handler-4.4.5.tgz#2aea598fdf3dc4e32667d673d48abd4a073665f4" + integrity sha512-CMnzM9R2WqlqXQGtIlsHMEZfXKJVTIrqCNoSd/QpAyp+Dw0a1Vps13l6ma1fH8g7zSPNsA59B/kWgeylFuA/lw== dependencies: - "@smithy/abort-controller" "^4.0.4" - "@smithy/protocol-http" "^5.1.2" - "@smithy/querystring-builder" "^4.0.4" - "@smithy/types" "^4.3.1" + "@smithy/abort-controller" "^4.2.5" + "@smithy/protocol-http" "^5.3.5" + "@smithy/querystring-builder" "^4.2.5" + "@smithy/types" "^4.9.0" tslib "^2.6.2" -"@smithy/property-provider@^4.0.4": - version "4.0.4" - resolved "https://registry.yarnpkg.com/@smithy/property-provider/-/property-provider-4.0.4.tgz#303a8fd99665fff61eeb6ec3922eee53838962c5" - integrity sha512-qHJ2sSgu4FqF4U/5UUp4DhXNmdTrgmoAai6oQiM+c5RZ/sbDwJ12qxB1M6FnP+Tn/ggkPZf9ccn4jqKSINaquw== +"@smithy/property-provider@^4.2.5": + version "4.2.5" + resolved "https://registry.yarnpkg.com/@smithy/property-provider/-/property-provider-4.2.5.tgz#f75dc5735d29ca684abbc77504be9246340a43f0" + integrity sha512-8iLN1XSE1rl4MuxvQ+5OSk/Zb5El7NJZ1td6Tn+8dQQHIjp59Lwl6bd0+nzw6SKm2wSSriH2v/I9LPzUic7EOg== dependencies: - "@smithy/types" "^4.3.1" + "@smithy/types" "^4.9.0" tslib "^2.6.2" -"@smithy/protocol-http@^5.1.2": - version "5.1.2" - resolved "https://registry.yarnpkg.com/@smithy/protocol-http/-/protocol-http-5.1.2.tgz#8094860c2407f250b80c95899e0385112d6eb98b" - integrity sha512-rOG5cNLBXovxIrICSBm95dLqzfvxjEmuZx4KK3hWwPFHGdW3lxY0fZNXfv2zebfRO7sJZ5pKJYHScsqopeIWtQ== +"@smithy/protocol-http@^5.3.5": + version "5.3.5" + resolved "https://registry.yarnpkg.com/@smithy/protocol-http/-/protocol-http-5.3.5.tgz#a8f4296dd6d190752589e39ee95298d5c65a60db" + integrity sha512-RlaL+sA0LNMp03bf7XPbFmT5gN+w3besXSWMkA8rcmxLSVfiEXElQi4O2IWwPfxzcHkxqrwBFMbngB8yx/RvaQ== dependencies: - "@smithy/types" "^4.3.1" + "@smithy/types" "^4.9.0" tslib "^2.6.2" -"@smithy/querystring-builder@^4.0.4": - version "4.0.4" - resolved "https://registry.yarnpkg.com/@smithy/querystring-builder/-/querystring-builder-4.0.4.tgz#f7546efd59d457b3d2525a330c6137e5f907864c" - integrity sha512-SwREZcDnEYoh9tLNgMbpop+UTGq44Hl9tdj3rf+yeLcfH7+J8OXEBaMc2kDxtyRHu8BhSg9ADEx0gFHvpJgU8w== +"@smithy/querystring-builder@^4.2.5": + version "4.2.5" + resolved "https://registry.yarnpkg.com/@smithy/querystring-builder/-/querystring-builder-4.2.5.tgz#00cafa5a4055600ab8058e26db42f580146b91f3" + integrity sha512-y98otMI1saoajeik2kLfGyRp11e5U/iJYH/wLCh3aTV/XutbGT9nziKGkgCaMD1ghK7p6htHMm6b6scl9JRUWg== dependencies: - "@smithy/types" "^4.3.1" - "@smithy/util-uri-escape" "^4.0.0" + "@smithy/types" "^4.9.0" + "@smithy/util-uri-escape" "^4.2.0" tslib "^2.6.2" -"@smithy/querystring-parser@^4.0.4": - version "4.0.4" - resolved "https://registry.yarnpkg.com/@smithy/querystring-parser/-/querystring-parser-4.0.4.tgz#307ab95ee5f1a142ab46c2eddebeae68cb2f703d" - integrity sha512-6yZf53i/qB8gRHH/l2ZwUG5xgkPgQF15/KxH0DdXMDHjesA9MeZje/853ifkSY0x4m5S+dfDZ+c4x439PF0M2w== +"@smithy/querystring-parser@^4.2.5": + version "4.2.5" + resolved "https://registry.yarnpkg.com/@smithy/querystring-parser/-/querystring-parser-4.2.5.tgz#61d2e77c62f44196590fa0927dbacfbeaffe8c53" + integrity sha512-031WCTdPYgiQRYNPXznHXof2YM0GwL6SeaSyTH/P72M1Vz73TvCNH2Nq8Iu2IEPq9QP2yx0/nrw5YmSeAi/AjQ== dependencies: - "@smithy/types" "^4.3.1" + "@smithy/types" "^4.9.0" tslib "^2.6.2" -"@smithy/service-error-classification@^4.0.6": - version "4.0.6" - resolved "https://registry.yarnpkg.com/@smithy/service-error-classification/-/service-error-classification-4.0.6.tgz#5d4d3017f5b62258fbfc1067e14198e125a8286c" - integrity sha512-RRoTDL//7xi4tn5FrN2NzH17jbgmnKidUqd4KvquT0954/i6CXXkh1884jBiunq24g9cGtPBEXlU40W6EpNOOg== +"@smithy/service-error-classification@^4.2.5": + version "4.2.5" + resolved "https://registry.yarnpkg.com/@smithy/service-error-classification/-/service-error-classification-4.2.5.tgz#a64eb78e096e59cc71141e3fea2b4194ce59b4fd" + integrity sha512-8fEvK+WPE3wUAcDvqDQG1Vk3ANLR8Px979te96m84CbKAjBVf25rPYSzb4xU4hlTyho7VhOGnh5i62D/JVF0JQ== dependencies: - "@smithy/types" "^4.3.1" + "@smithy/types" "^4.9.0" -"@smithy/shared-ini-file-loader@^4.0.4": - version "4.0.4" - resolved "https://registry.yarnpkg.com/@smithy/shared-ini-file-loader/-/shared-ini-file-loader-4.0.4.tgz#33c63468b95cfd5e7d642c8131d7acc034025e00" - integrity sha512-63X0260LoFBjrHifPDs+nM9tV0VMkOTl4JRMYNuKh/f5PauSjowTfvF3LogfkWdcPoxsA9UjqEOgjeYIbhb7Nw== +"@smithy/shared-ini-file-loader@^4.4.0": + version "4.4.0" + resolved "https://registry.yarnpkg.com/@smithy/shared-ini-file-loader/-/shared-ini-file-loader-4.4.0.tgz#a2f8282f49982f00bafb1fa8cb7fc188a202a594" + integrity sha512-5WmZ5+kJgJDjwXXIzr1vDTG+RhF9wzSODQBfkrQ2VVkYALKGvZX1lgVSxEkgicSAFnFhPj5rudJV0zoinqS0bA== dependencies: - "@smithy/types" "^4.3.1" + "@smithy/types" "^4.9.0" tslib "^2.6.2" -"@smithy/signature-v4@^5.1.2": - version "5.1.2" - resolved "https://registry.yarnpkg.com/@smithy/signature-v4/-/signature-v4-5.1.2.tgz#5afd9d428bd26bb660bee8075b6e89fe93600c22" - integrity sha512-d3+U/VpX7a60seHziWnVZOHuEgJlclufjkS6zhXvxcJgkJq4UWdH5eOBLzHRMx6gXjsdT9h6lfpmLzbrdupHgQ== - dependencies: - "@smithy/is-array-buffer" "^4.0.0" - "@smithy/protocol-http" "^5.1.2" - "@smithy/types" "^4.3.1" - "@smithy/util-hex-encoding" "^4.0.0" - "@smithy/util-middleware" "^4.0.4" - "@smithy/util-uri-escape" "^4.0.0" - "@smithy/util-utf8" "^4.0.0" +"@smithy/signature-v4@^5.3.5": + version "5.3.5" + resolved "https://registry.yarnpkg.com/@smithy/signature-v4/-/signature-v4-5.3.5.tgz#13ab710653f9f16c325ee7e0a102a44f73f2643f" + integrity sha512-xSUfMu1FT7ccfSXkoLl/QRQBi2rOvi3tiBZU2Tdy3I6cgvZ6SEi9QNey+lqps/sJRnogIS+lq+B1gxxbra2a/w== + dependencies: + "@smithy/is-array-buffer" "^4.2.0" + "@smithy/protocol-http" "^5.3.5" + "@smithy/types" "^4.9.0" + "@smithy/util-hex-encoding" "^4.2.0" + "@smithy/util-middleware" "^4.2.5" + "@smithy/util-uri-escape" "^4.2.0" + "@smithy/util-utf8" "^4.2.0" tslib "^2.6.2" -"@smithy/smithy-client@^4.4.9": - version "4.4.9" - resolved "https://registry.yarnpkg.com/@smithy/smithy-client/-/smithy-client-4.4.9.tgz#973875a750908266aaf5f73c0714016b7e883609" - integrity sha512-mbMg8mIUAWwMmb74LoYiArP04zWElPzDoA1jVOp3or0cjlDMgoS6WTC3QXK0Vxoc9I4zdrX0tq6qsOmaIoTWEQ== - dependencies: - "@smithy/core" "^3.7.2" - "@smithy/middleware-endpoint" "^4.1.17" - "@smithy/middleware-stack" "^4.0.4" - "@smithy/protocol-http" "^5.1.2" - "@smithy/types" "^4.3.1" - "@smithy/util-stream" "^4.2.3" +"@smithy/smithy-client@^4.9.8", "@smithy/smithy-client@^4.9.9": + version "4.9.9" + resolved "https://registry.yarnpkg.com/@smithy/smithy-client/-/smithy-client-4.9.9.tgz#c404029e85a62b5d4130839f7930f7071de00244" + integrity sha512-SUnZJMMo5yCmgjopJbiNeo1vlr8KvdnEfIHV9rlD77QuOGdRotIVBcOrBuMr+sI9zrnhtDtLP054bZVbpZpiQA== + dependencies: + "@smithy/core" "^3.18.6" + "@smithy/middleware-endpoint" "^4.3.13" + "@smithy/middleware-stack" "^4.2.5" + "@smithy/protocol-http" "^5.3.5" + "@smithy/types" "^4.9.0" + "@smithy/util-stream" "^4.5.6" tslib "^2.6.2" -"@smithy/types@^4.3.1": - version "4.3.1" - resolved "https://registry.yarnpkg.com/@smithy/types/-/types-4.3.1.tgz#c11276ea16235d798f47a68aef9f44d3dbb70dd4" - integrity sha512-UqKOQBL2x6+HWl3P+3QqFD4ncKq0I8Nuz9QItGv5WuKuMHuuwlhvqcZCoXGfc+P1QmfJE7VieykoYYmrOoFJxA== +"@smithy/types@^4.9.0": + version "4.9.0" + resolved "https://registry.yarnpkg.com/@smithy/types/-/types-4.9.0.tgz#c6636ddfa142e1ddcb6e4cf5f3e1a628d420486f" + integrity sha512-MvUbdnXDTwykR8cB1WZvNNwqoWVaTRA0RLlLmf/cIFNMM2cKWz01X4Ly6SMC4Kks30r8tT3Cty0jmeWfiuyHTA== dependencies: tslib "^2.6.2" -"@smithy/url-parser@^4.0.4": - version "4.0.4" - resolved "https://registry.yarnpkg.com/@smithy/url-parser/-/url-parser-4.0.4.tgz#049143f4c156356e177bd69242675db26fe4f4db" - integrity sha512-eMkc144MuN7B0TDA4U2fKs+BqczVbk3W+qIvcoCY6D1JY3hnAdCuhCZODC+GAeaxj0p6Jroz4+XMUn3PCxQQeQ== +"@smithy/url-parser@^4.2.5": + version "4.2.5" + resolved "https://registry.yarnpkg.com/@smithy/url-parser/-/url-parser-4.2.5.tgz#2fea006108f17f7761432c7ef98d6aa003421487" + integrity sha512-VaxMGsilqFnK1CeBX+LXnSuaMx4sTL/6znSZh2829txWieazdVxr54HmiyTsIbpOTLcf5nYpq9lpzmwRdxj6rQ== dependencies: - "@smithy/querystring-parser" "^4.0.4" - "@smithy/types" "^4.3.1" + "@smithy/querystring-parser" "^4.2.5" + "@smithy/types" "^4.9.0" tslib "^2.6.2" -"@smithy/util-base64@^4.0.0": - version "4.0.0" - resolved "https://registry.yarnpkg.com/@smithy/util-base64/-/util-base64-4.0.0.tgz#8345f1b837e5f636e5f8470c4d1706ae0c6d0358" - integrity sha512-CvHfCmO2mchox9kjrtzoHkWHxjHZzaFojLc8quxXY7WAAMAg43nuxwv95tATVgQFNDwd4M9S1qFzj40Ul41Kmg== +"@smithy/util-base64@^4.3.0": + version "4.3.0" + resolved "https://registry.yarnpkg.com/@smithy/util-base64/-/util-base64-4.3.0.tgz#5e287b528793aa7363877c1a02cd880d2e76241d" + integrity sha512-GkXZ59JfyxsIwNTWFnjmFEI8kZpRNIBfxKjv09+nkAWPt/4aGaEWMM04m4sxgNVWkbt2MdSvE3KF/PfX4nFedQ== dependencies: - "@smithy/util-buffer-from" "^4.0.0" - "@smithy/util-utf8" "^4.0.0" + "@smithy/util-buffer-from" "^4.2.0" + "@smithy/util-utf8" "^4.2.0" tslib "^2.6.2" -"@smithy/util-body-length-browser@^4.0.0": - version "4.0.0" - resolved "https://registry.yarnpkg.com/@smithy/util-body-length-browser/-/util-body-length-browser-4.0.0.tgz#965d19109a4b1e5fe7a43f813522cce718036ded" - integrity sha512-sNi3DL0/k64/LO3A256M+m3CDdG6V7WKWHdAiBBMUN8S3hK3aMPhwnPik2A/a2ONN+9doY9UxaLfgqsIRg69QA== +"@smithy/util-body-length-browser@^4.2.0": + version "4.2.0" + resolved "https://registry.yarnpkg.com/@smithy/util-body-length-browser/-/util-body-length-browser-4.2.0.tgz#04e9fc51ee7a3e7f648a4b4bcdf96c350cfa4d61" + integrity sha512-Fkoh/I76szMKJnBXWPdFkQJl2r9SjPt3cMzLdOB6eJ4Pnpas8hVoWPYemX/peO0yrrvldgCUVJqOAjUrOLjbxg== dependencies: tslib "^2.6.2" -"@smithy/util-body-length-node@^4.0.0": - version "4.0.0" - resolved "https://registry.yarnpkg.com/@smithy/util-body-length-node/-/util-body-length-node-4.0.0.tgz#3db245f6844a9b1e218e30c93305bfe2ffa473b3" - integrity sha512-q0iDP3VsZzqJyje8xJWEJCNIu3lktUGVoSy1KB0UWym2CL1siV3artm+u1DFYTLejpsrdGyCSWBdGNjJzfDPjg== +"@smithy/util-body-length-node@^4.2.1": + version "4.2.1" + resolved "https://registry.yarnpkg.com/@smithy/util-body-length-node/-/util-body-length-node-4.2.1.tgz#79c8a5d18e010cce6c42d5cbaf6c1958523e6fec" + integrity sha512-h53dz/pISVrVrfxV1iqXlx5pRg3V2YWFcSQyPyXZRrZoZj4R4DeWRDo1a7dd3CPTcFi3kE+98tuNyD2axyZReA== dependencies: tslib "^2.6.2" @@ -1376,96 +1373,95 @@ "@smithy/is-array-buffer" "^2.2.0" tslib "^2.6.2" -"@smithy/util-buffer-from@^4.0.0": - version "4.0.0" - resolved "https://registry.yarnpkg.com/@smithy/util-buffer-from/-/util-buffer-from-4.0.0.tgz#b23b7deb4f3923e84ef50c8b2c5863d0dbf6c0b9" - integrity sha512-9TOQ7781sZvddgO8nxueKi3+yGvkY35kotA0Y6BWRajAv8jjmigQ1sBwz0UX47pQMYXJPahSKEKYFgt+rXdcug== +"@smithy/util-buffer-from@^4.2.0": + version "4.2.0" + resolved "https://registry.yarnpkg.com/@smithy/util-buffer-from/-/util-buffer-from-4.2.0.tgz#7abd12c4991b546e7cee24d1e8b4bfaa35c68a9d" + integrity sha512-kAY9hTKulTNevM2nlRtxAG2FQ3B2OR6QIrPY3zE5LqJy1oxzmgBGsHLWTcNhWXKchgA0WHW+mZkQrng/pgcCew== dependencies: - "@smithy/is-array-buffer" "^4.0.0" + "@smithy/is-array-buffer" "^4.2.0" tslib "^2.6.2" -"@smithy/util-config-provider@^4.0.0": - version "4.0.0" - resolved "https://registry.yarnpkg.com/@smithy/util-config-provider/-/util-config-provider-4.0.0.tgz#e0c7c8124c7fba0b696f78f0bd0ccb060997d45e" - integrity sha512-L1RBVzLyfE8OXH+1hsJ8p+acNUSirQnWQ6/EgpchV88G6zGBTDPdXiiExei6Z1wR2RxYvxY/XLw6AMNCCt8H3w== +"@smithy/util-config-provider@^4.2.0": + version "4.2.0" + resolved "https://registry.yarnpkg.com/@smithy/util-config-provider/-/util-config-provider-4.2.0.tgz#2e4722937f8feda4dcb09672c59925a4e6286cfc" + integrity sha512-YEjpl6XJ36FTKmD+kRJJWYvrHeUvm5ykaUS5xK+6oXffQPHeEM4/nXlZPe+Wu0lsgRUcNZiliYNh/y7q9c2y6Q== dependencies: tslib "^2.6.2" -"@smithy/util-defaults-mode-browser@^4.0.25": - version "4.0.25" - resolved "https://registry.yarnpkg.com/@smithy/util-defaults-mode-browser/-/util-defaults-mode-browser-4.0.25.tgz#781411de904f616c15900ab0a88b37bd8002c5c5" - integrity sha512-pxEWsxIsOPLfKNXvpgFHBGFC3pKYKUFhrud1kyooO9CJai6aaKDHfT10Mi5iiipPXN/JhKAu3qX9o75+X85OdQ== +"@smithy/util-defaults-mode-browser@^4.3.11": + version "4.3.12" + resolved "https://registry.yarnpkg.com/@smithy/util-defaults-mode-browser/-/util-defaults-mode-browser-4.3.12.tgz#dd0c76d0414428011437479faa1d28b68d01271f" + integrity sha512-TKc6FnOxFULKxLgTNHYjcFqdOYzXVPFFVm5JhI30F3RdhT7nYOtOsjgaOwfDRmA/3U66O9KaBQ3UHoXwayRhAg== dependencies: - "@smithy/property-provider" "^4.0.4" - "@smithy/smithy-client" "^4.4.9" - "@smithy/types" "^4.3.1" - bowser "^2.11.0" + "@smithy/property-provider" "^4.2.5" + "@smithy/smithy-client" "^4.9.9" + "@smithy/types" "^4.9.0" tslib "^2.6.2" -"@smithy/util-defaults-mode-node@^4.0.25": - version "4.0.25" - resolved "https://registry.yarnpkg.com/@smithy/util-defaults-mode-node/-/util-defaults-mode-node-4.0.25.tgz#8e307a15a73c56af44674aaa74cd089b3b42b019" - integrity sha512-+w4n4hKFayeCyELZLfsSQG5mCC3TwSkmRHv4+el5CzFU8ToQpYGhpV7mrRzqlwKkntlPilT1HJy1TVeEvEjWOQ== - dependencies: - "@smithy/config-resolver" "^4.1.4" - "@smithy/credential-provider-imds" "^4.0.6" - "@smithy/node-config-provider" "^4.1.3" - "@smithy/property-provider" "^4.0.4" - "@smithy/smithy-client" "^4.4.9" - "@smithy/types" "^4.3.1" +"@smithy/util-defaults-mode-node@^4.2.14": + version "4.2.15" + resolved "https://registry.yarnpkg.com/@smithy/util-defaults-mode-node/-/util-defaults-mode-node-4.2.15.tgz#f04e40ae98b49088f65bc503d3be7eefcff55100" + integrity sha512-94NqfQVo+vGc5gsQ9SROZqOvBkGNMQu6pjXbnn8aQvBUhc31kx49gxlkBEqgmaZQHUUfdRUin5gK/HlHKmbAwg== + dependencies: + "@smithy/config-resolver" "^4.4.3" + "@smithy/credential-provider-imds" "^4.2.5" + "@smithy/node-config-provider" "^4.3.5" + "@smithy/property-provider" "^4.2.5" + "@smithy/smithy-client" "^4.9.9" + "@smithy/types" "^4.9.0" tslib "^2.6.2" -"@smithy/util-endpoints@^3.0.6": - version "3.0.6" - resolved "https://registry.yarnpkg.com/@smithy/util-endpoints/-/util-endpoints-3.0.6.tgz#a24b0801a1b94c0de26ad83da206b9add68117f2" - integrity sha512-YARl3tFL3WgPuLzljRUnrS2ngLiUtkwhQtj8PAL13XZSyUiNLQxwG3fBBq3QXFqGFUXepIN73pINp3y8c2nBmA== +"@smithy/util-endpoints@^3.2.5": + version "3.2.5" + resolved "https://registry.yarnpkg.com/@smithy/util-endpoints/-/util-endpoints-3.2.5.tgz#9e0fc34e38ddfbbc434d23a38367638dc100cb14" + integrity sha512-3O63AAWu2cSNQZp+ayl9I3NapW1p1rR5mlVHcF6hAB1dPZUQFfRPYtplWX/3xrzWthPGj5FqB12taJJCfH6s8A== dependencies: - "@smithy/node-config-provider" "^4.1.3" - "@smithy/types" "^4.3.1" + "@smithy/node-config-provider" "^4.3.5" + "@smithy/types" "^4.9.0" tslib "^2.6.2" -"@smithy/util-hex-encoding@^4.0.0": - version "4.0.0" - resolved "https://registry.yarnpkg.com/@smithy/util-hex-encoding/-/util-hex-encoding-4.0.0.tgz#dd449a6452cffb37c5b1807ec2525bb4be551e8d" - integrity sha512-Yk5mLhHtfIgW2W2WQZWSg5kuMZCVbvhFmC7rV4IO2QqnZdbEFPmQnCcGMAX2z/8Qj3B9hYYNjZOhWym+RwhePw== +"@smithy/util-hex-encoding@^4.2.0": + version "4.2.0" + resolved "https://registry.yarnpkg.com/@smithy/util-hex-encoding/-/util-hex-encoding-4.2.0.tgz#1c22ea3d1e2c3a81ff81c0a4f9c056a175068a7b" + integrity sha512-CCQBwJIvXMLKxVbO88IukazJD9a4kQ9ZN7/UMGBjBcJYvatpWk+9g870El4cB8/EJxfe+k+y0GmR9CAzkF+Nbw== dependencies: tslib "^2.6.2" -"@smithy/util-middleware@^4.0.4": - version "4.0.4" - resolved "https://registry.yarnpkg.com/@smithy/util-middleware/-/util-middleware-4.0.4.tgz#8f639de049082c687841ea5e69c6c36e12e31a3c" - integrity sha512-9MLKmkBmf4PRb0ONJikCbCwORACcil6gUWojwARCClT7RmLzF04hUR4WdRprIXal7XVyrddadYNfp2eF3nrvtQ== +"@smithy/util-middleware@^4.2.5": + version "4.2.5" + resolved "https://registry.yarnpkg.com/@smithy/util-middleware/-/util-middleware-4.2.5.tgz#1ace865afe678fd4b0f9217197e2fe30178d4835" + integrity sha512-6Y3+rvBF7+PZOc40ybeZMcGln6xJGVeY60E7jy9Mv5iKpMJpHgRE6dKy9ScsVxvfAYuEX4Q9a65DQX90KaQ3bA== dependencies: - "@smithy/types" "^4.3.1" + "@smithy/types" "^4.9.0" tslib "^2.6.2" -"@smithy/util-retry@^4.0.6": - version "4.0.6" - resolved "https://registry.yarnpkg.com/@smithy/util-retry/-/util-retry-4.0.6.tgz#f931fdd1f01786b21a82711e185c58410e8e41c7" - integrity sha512-+YekoF2CaSMv6zKrA6iI/N9yva3Gzn4L6n35Luydweu5MMPYpiGZlWqehPHDHyNbnyaYlz/WJyYAZnC+loBDZg== +"@smithy/util-retry@^4.2.5": + version "4.2.5" + resolved "https://registry.yarnpkg.com/@smithy/util-retry/-/util-retry-4.2.5.tgz#70fe4fbbfb9ad43a9ce2ba4ed111ff7b30d7b333" + integrity sha512-GBj3+EZBbN4NAqJ/7pAhsXdfzdlznOh8PydUijy6FpNIMnHPSMO2/rP4HKu+UFeikJxShERk528oy7GT79YiJg== dependencies: - "@smithy/service-error-classification" "^4.0.6" - "@smithy/types" "^4.3.1" + "@smithy/service-error-classification" "^4.2.5" + "@smithy/types" "^4.9.0" tslib "^2.6.2" -"@smithy/util-stream@^4.2.3": - version "4.2.3" - resolved "https://registry.yarnpkg.com/@smithy/util-stream/-/util-stream-4.2.3.tgz#7980fb94dbee96301b0b2610de8ae1700c7daab1" - integrity sha512-cQn412DWHHFNKrQfbHY8vSFI3nTROY1aIKji9N0tpp8gUABRilr7wdf8fqBbSlXresobM+tQFNk6I+0LXK/YZg== - dependencies: - "@smithy/fetch-http-handler" "^5.1.0" - "@smithy/node-http-handler" "^4.1.0" - "@smithy/types" "^4.3.1" - "@smithy/util-base64" "^4.0.0" - "@smithy/util-buffer-from" "^4.0.0" - "@smithy/util-hex-encoding" "^4.0.0" - "@smithy/util-utf8" "^4.0.0" +"@smithy/util-stream@^4.5.6": + version "4.5.6" + resolved "https://registry.yarnpkg.com/@smithy/util-stream/-/util-stream-4.5.6.tgz#ebee9e52adeb6f88337778b2f3356a2cc615298c" + integrity sha512-qWw/UM59TiaFrPevefOZ8CNBKbYEP6wBAIlLqxn3VAIo9rgnTNc4ASbVrqDmhuwI87usnjhdQrxodzAGFFzbRQ== + dependencies: + "@smithy/fetch-http-handler" "^5.3.6" + "@smithy/node-http-handler" "^4.4.5" + "@smithy/types" "^4.9.0" + "@smithy/util-base64" "^4.3.0" + "@smithy/util-buffer-from" "^4.2.0" + "@smithy/util-hex-encoding" "^4.2.0" + "@smithy/util-utf8" "^4.2.0" tslib "^2.6.2" -"@smithy/util-uri-escape@^4.0.0": - version "4.0.0" - resolved "https://registry.yarnpkg.com/@smithy/util-uri-escape/-/util-uri-escape-4.0.0.tgz#a96c160c76f3552458a44d8081fade519d214737" - integrity sha512-77yfbCbQMtgtTylO9itEAdpPXSog3ZxMe09AEhm0dU0NLTalV70ghDZFR+Nfi1C60jnJoh/Re4090/DuZh2Omg== +"@smithy/util-uri-escape@^4.2.0": + version "4.2.0" + resolved "https://registry.yarnpkg.com/@smithy/util-uri-escape/-/util-uri-escape-4.2.0.tgz#096a4cec537d108ac24a68a9c60bee73fc7e3a9e" + integrity sha512-igZpCKV9+E/Mzrpq6YacdTQ0qTiLm85gD6N/IrmyDvQFA4UnU3d5g3m8tMT/6zG/vVkWSU+VxeUyGonL62DuxA== dependencies: tslib "^2.6.2" @@ -1477,27 +1473,34 @@ "@smithy/util-buffer-from" "^2.2.0" tslib "^2.6.2" -"@smithy/util-utf8@^4.0.0": - version "4.0.0" - resolved "https://registry.yarnpkg.com/@smithy/util-utf8/-/util-utf8-4.0.0.tgz#09ca2d9965e5849e72e347c130f2a29d5c0c863c" - integrity sha512-b+zebfKCfRdgNJDknHCob3O7FpeYQN6ZG6YLExMcasDHsCXlsXCEuiPZeLnJLpwa5dvPetGlnGCiMHuLwGvFow== +"@smithy/util-utf8@^4.2.0": + version "4.2.0" + resolved "https://registry.yarnpkg.com/@smithy/util-utf8/-/util-utf8-4.2.0.tgz#8b19d1514f621c44a3a68151f3d43e51087fed9d" + integrity sha512-zBPfuzoI8xyBtR2P6WQj63Rz8i3AmfAaJLuNG8dWsfvPe8lO4aCPYLn879mEgHndZH1zQ2oXmG8O1GGzzaoZiw== dependencies: - "@smithy/util-buffer-from" "^4.0.0" + "@smithy/util-buffer-from" "^4.2.0" tslib "^2.6.2" -"@smithy/util-waiter@^4.0.6": - version "4.0.6" - resolved "https://registry.yarnpkg.com/@smithy/util-waiter/-/util-waiter-4.0.6.tgz#38044da5053f0d9118df05f55cd8fbec14ecf9da" - integrity sha512-slcr1wdRbX7NFphXZOxtxRNA7hXAAtJAXJDE/wdoMAos27SIquVCKiSqfB6/28YzQ8FCsB5NKkhdM5gMADbqxg== +"@smithy/util-waiter@^4.2.5": + version "4.2.5" + resolved "https://registry.yarnpkg.com/@smithy/util-waiter/-/util-waiter-4.2.5.tgz#e527816edae20ec5f68b25685f4b21d93424ea86" + integrity sha512-Dbun99A3InifQdIrsXZ+QLcC0PGBPAdrl4cj1mTgJvyc9N2zf7QSxg8TBkzsCmGJdE3TLbO9ycwpY0EkWahQ/g== + dependencies: + "@smithy/abort-controller" "^4.2.5" + "@smithy/types" "^4.9.0" + tslib "^2.6.2" + +"@smithy/uuid@^1.1.0": + version "1.1.0" + resolved "https://registry.yarnpkg.com/@smithy/uuid/-/uuid-1.1.0.tgz#9fd09d3f91375eab94f478858123387df1cda987" + integrity sha512-4aUIteuyxtBUhVdiQqcDhKFitwfd9hqoSDYY2KRXiWtgoWJ9Bmise+KfEPDiVHWeJepvF8xJO9/9+WDIciMFFw== dependencies: - "@smithy/abort-controller" "^4.0.4" - "@smithy/types" "^4.3.1" tslib "^2.6.2" "@types/aws-lambda@^8.10.152": - version "8.10.152" - resolved "https://registry.yarnpkg.com/@types/aws-lambda/-/aws-lambda-8.10.152.tgz#f68424a8175f0a54a2a941e65b76c3f51f3bd89d" - integrity sha512-soT/c2gYBnT5ygwiHPmd9a1bftj462NWVk2tKCc1PYHSIacB2UwbTS2zYG4jzag1mRDuzg/OjtxQjQ2NKRB6Rw== + version "8.10.159" + resolved "https://registry.yarnpkg.com/@types/aws-lambda/-/aws-lambda-8.10.159.tgz#0ab559f4519e42732a393b28c21564da9763c5aa" + integrity sha512-SAP22WSGNN12OQ8PlCzGzRCZ7QDCwI85dQZbmpz7+mAk+L7j+wI7qnvmdKh+o7A5LaOp6QnOZ2NJphAZQTTHQg== "@types/estree@^1.0.6", "@types/estree@^1.0.8": version "1.0.8" @@ -1527,11 +1530,11 @@ integrity sha512-dRLjCWHYg4oaA77cxO64oO+7JwCwnIzkZPdrrC71jQmQtlhM556pwKo5bUzqvZndkVbeFLIIi+9TC40JNF5hNQ== "@types/node@*", "@types/node@>=0.0.2", "@types/node@>=4.0.0", "@types/node@^24.1.0": - version "24.1.0" - resolved "https://registry.yarnpkg.com/@types/node/-/node-24.1.0.tgz#0993f7dc31ab5cc402d112315b463e383d68a49c" - integrity sha512-ut5FthK5moxFKH2T1CUOC6ctR67rQRvvHdFLCD2Ql6KXmMuCrjsSsRI9UsLCm9M18BMwClv4pn327UvB7eeO1w== + version "24.10.1" + resolved "https://registry.yarnpkg.com/@types/node/-/node-24.10.1.tgz#91e92182c93db8bd6224fca031e2370cef9a8f01" + integrity sha512-GNWcUTRBgIRJD5zj+Tq0fKOJ5XZajIiBroOF0yvj2bSU1WvNdYS/dn9UxwsujGW4JX06dnHyjV2y9rRaybH0iQ== dependencies: - undici-types "~7.8.0" + undici-types "~7.16.0" "@types/sprintf-js@^1.1.4": version "1.1.4" @@ -1550,112 +1553,106 @@ resolved "https://registry.yarnpkg.com/@types/unist/-/unist-3.0.3.tgz#acaab0f919ce69cce629c2d4ed2eb4adc1b6c20c" integrity sha512-ko/gIFJRv177XgZsZcBwnqJN5x/Gien8qNOn0D5bQU/zAzVf9Zt3BlcUiLqhV9y4ARk0GbT3tnUiPNgnTXzc/Q== -"@types/uuid@^9.0.1": - version "9.0.8" - resolved "https://registry.yarnpkg.com/@types/uuid/-/uuid-9.0.8.tgz#7545ba4fc3c003d6c756f651f3bf163d8f0f29ba" - integrity sha512-jg+97EGIcY9AGHJJRaaPVgetKDsrTgbRjQ5Msgjh/DQKEFl0DtyRr/VCOyD1T2R1MNeWPK/u7JoGhlDZnKBAfA== - "@types/yoga-layout@1.9.2": version "1.9.2" resolved "https://registry.yarnpkg.com/@types/yoga-layout/-/yoga-layout-1.9.2.tgz#efaf9e991a7390dc081a0b679185979a83a9639a" integrity sha512-S9q47ByT2pPvD65IvrWp7qppVMpk9WGMbVq9wbWZOHg6tnXSD4vyhao6nOSBwwfDdV2p3Kx9evA9vI+XWTfDvw== "@typescript-eslint/eslint-plugin@^8.38.0": - version "8.38.0" - resolved "https://registry.yarnpkg.com/@typescript-eslint/eslint-plugin/-/eslint-plugin-8.38.0.tgz#6e5220d16f2691ab6d983c1737dd5b36e17641b7" - integrity sha512-CPoznzpuAnIOl4nhj4tRr4gIPj5AfKgkiJmGQDaq+fQnRJTYlcBjbX3wbciGmpoPf8DREufuPRe1tNMZnGdanA== + version "8.48.1" + resolved "https://registry.yarnpkg.com/@typescript-eslint/eslint-plugin/-/eslint-plugin-8.48.1.tgz#c772d1dbdd97cfddf85f5a161a97783233643631" + integrity sha512-X63hI1bxl5ohelzr0LY5coufyl0LJNthld+abwxpCoo6Gq+hSqhKwci7MUWkXo67mzgUK6YFByhmaHmUcuBJmA== dependencies: "@eslint-community/regexpp" "^4.10.0" - "@typescript-eslint/scope-manager" "8.38.0" - "@typescript-eslint/type-utils" "8.38.0" - "@typescript-eslint/utils" "8.38.0" - "@typescript-eslint/visitor-keys" "8.38.0" + "@typescript-eslint/scope-manager" "8.48.1" + "@typescript-eslint/type-utils" "8.48.1" + "@typescript-eslint/utils" "8.48.1" + "@typescript-eslint/visitor-keys" "8.48.1" graphemer "^1.4.0" ignore "^7.0.0" natural-compare "^1.4.0" ts-api-utils "^2.1.0" "@typescript-eslint/parser@^8.38.0": - version "8.38.0" - resolved "https://registry.yarnpkg.com/@typescript-eslint/parser/-/parser-8.38.0.tgz#6723a5ea881e1777956b1045cba30be5ea838293" - integrity sha512-Zhy8HCvBUEfBECzIl1PKqF4p11+d0aUJS1GeUiuqK9WmOug8YCmC4h4bjyBvMyAMI9sbRczmrYL5lKg/YMbrcQ== - dependencies: - "@typescript-eslint/scope-manager" "8.38.0" - "@typescript-eslint/types" "8.38.0" - "@typescript-eslint/typescript-estree" "8.38.0" - "@typescript-eslint/visitor-keys" "8.38.0" + version "8.48.1" + resolved "https://registry.yarnpkg.com/@typescript-eslint/parser/-/parser-8.48.1.tgz#4e3c66d9ec20683ec142417fafeadab61c479c3f" + integrity sha512-PC0PDZfJg8sP7cmKe6L3QIL8GZwU5aRvUFedqSIpw3B+QjRSUZeeITC2M5XKeMXEzL6wccN196iy3JLwKNvDVA== + dependencies: + "@typescript-eslint/scope-manager" "8.48.1" + "@typescript-eslint/types" "8.48.1" + "@typescript-eslint/typescript-estree" "8.48.1" + "@typescript-eslint/visitor-keys" "8.48.1" debug "^4.3.4" -"@typescript-eslint/project-service@8.38.0": - version "8.38.0" - resolved "https://registry.yarnpkg.com/@typescript-eslint/project-service/-/project-service-8.38.0.tgz#4900771f943163027fd7d2020a062892056b5e2f" - integrity sha512-dbK7Jvqcb8c9QfH01YB6pORpqX1mn5gDZc9n63Ak/+jD67oWXn3Gs0M6vddAN+eDXBCS5EmNWzbSxsn9SzFWWg== +"@typescript-eslint/project-service@8.48.1": + version "8.48.1" + resolved "https://registry.yarnpkg.com/@typescript-eslint/project-service/-/project-service-8.48.1.tgz#cfe1741613b9112d85ae766de9e09b27a7d3f2f1" + integrity sha512-HQWSicah4s9z2/HifRPQ6b6R7G+SBx64JlFQpgSSHWPKdvCZX57XCbszg/bapbRsOEv42q5tayTYcEFpACcX1w== dependencies: - "@typescript-eslint/tsconfig-utils" "^8.38.0" - "@typescript-eslint/types" "^8.38.0" + "@typescript-eslint/tsconfig-utils" "^8.48.1" + "@typescript-eslint/types" "^8.48.1" debug "^4.3.4" -"@typescript-eslint/scope-manager@8.38.0": - version "8.38.0" - resolved "https://registry.yarnpkg.com/@typescript-eslint/scope-manager/-/scope-manager-8.38.0.tgz#5a0efcb5c9cf6e4121b58f87972f567c69529226" - integrity sha512-WJw3AVlFFcdT9Ri1xs/lg8LwDqgekWXWhH3iAF+1ZM+QPd7oxQ6jvtW/JPwzAScxitILUIFs0/AnQ/UWHzbATQ== +"@typescript-eslint/scope-manager@8.48.1": + version "8.48.1" + resolved "https://registry.yarnpkg.com/@typescript-eslint/scope-manager/-/scope-manager-8.48.1.tgz#8bc70643e7cca57864b1ff95dd350fc27756bec0" + integrity sha512-rj4vWQsytQbLxC5Bf4XwZ0/CKd362DkWMUkviT7DCS057SK64D5lH74sSGzhI6PDD2HCEq02xAP9cX68dYyg1w== dependencies: - "@typescript-eslint/types" "8.38.0" - "@typescript-eslint/visitor-keys" "8.38.0" + "@typescript-eslint/types" "8.48.1" + "@typescript-eslint/visitor-keys" "8.48.1" -"@typescript-eslint/tsconfig-utils@8.38.0", "@typescript-eslint/tsconfig-utils@^8.38.0": - version "8.38.0" - resolved "https://registry.yarnpkg.com/@typescript-eslint/tsconfig-utils/-/tsconfig-utils-8.38.0.tgz#6de4ce224a779601a8df667db56527255c42c4d0" - integrity sha512-Lum9RtSE3EroKk/bYns+sPOodqb2Fv50XOl/gMviMKNvanETUuUcC9ObRbzrJ4VSd2JalPqgSAavwrPiPvnAiQ== +"@typescript-eslint/tsconfig-utils@8.48.1", "@typescript-eslint/tsconfig-utils@^8.48.1": + version "8.48.1" + resolved "https://registry.yarnpkg.com/@typescript-eslint/tsconfig-utils/-/tsconfig-utils-8.48.1.tgz#68139ce2d258f984e2b33a95389158f1212af646" + integrity sha512-k0Jhs4CpEffIBm6wPaCXBAD7jxBtrHjrSgtfCjUvPp9AZ78lXKdTR8fxyZO5y4vWNlOvYXRtngSZNSn+H53Jkw== -"@typescript-eslint/type-utils@8.38.0": - version "8.38.0" - resolved "https://registry.yarnpkg.com/@typescript-eslint/type-utils/-/type-utils-8.38.0.tgz#a56cd84765fa6ec135fe252b5db61e304403a85b" - integrity sha512-c7jAvGEZVf0ao2z+nnz8BUaHZD09Agbh+DY7qvBQqLiz8uJzRgVPj5YvOh8I8uEiH8oIUGIfHzMwUcGVco/SJg== +"@typescript-eslint/type-utils@8.48.1": + version "8.48.1" + resolved "https://registry.yarnpkg.com/@typescript-eslint/type-utils/-/type-utils-8.48.1.tgz#955bd3ddd648450f0a627925ff12ade63fb7516d" + integrity sha512-1jEop81a3LrJQLTf/1VfPQdhIY4PlGDBc/i67EVWObrtvcziysbLN3oReexHOM6N3jyXgCrkBsZpqwH0hiDOQg== dependencies: - "@typescript-eslint/types" "8.38.0" - "@typescript-eslint/typescript-estree" "8.38.0" - "@typescript-eslint/utils" "8.38.0" + "@typescript-eslint/types" "8.48.1" + "@typescript-eslint/typescript-estree" "8.48.1" + "@typescript-eslint/utils" "8.48.1" debug "^4.3.4" ts-api-utils "^2.1.0" -"@typescript-eslint/types@8.38.0", "@typescript-eslint/types@^8.34.1", "@typescript-eslint/types@^8.38.0": - version "8.38.0" - resolved "https://registry.yarnpkg.com/@typescript-eslint/types/-/types-8.38.0.tgz#297351c994976b93c82ac0f0e206c8143aa82529" - integrity sha512-wzkUfX3plUqij4YwWaJyqhiPE5UCRVlFpKn1oCRn2O1bJ592XxWJj8ROQ3JD5MYXLORW84063z3tZTb/cs4Tyw== +"@typescript-eslint/types@8.48.1", "@typescript-eslint/types@^8.34.1", "@typescript-eslint/types@^8.48.1": + version "8.48.1" + resolved "https://registry.yarnpkg.com/@typescript-eslint/types/-/types-8.48.1.tgz#a9ff808f5f798f28767d5c0b015a88fa7ce46bd7" + integrity sha512-+fZ3LZNeiELGmimrujsDCT4CRIbq5oXdHe7chLiW8qzqyPMnn1puNstCrMNVAqwcl2FdIxkuJ4tOs/RFDBVc/Q== -"@typescript-eslint/typescript-estree@8.38.0": - version "8.38.0" - resolved "https://registry.yarnpkg.com/@typescript-eslint/typescript-estree/-/typescript-estree-8.38.0.tgz#82262199eb6778bba28a319e25ad05b1158957df" - integrity sha512-fooELKcAKzxux6fA6pxOflpNS0jc+nOQEEOipXFNjSlBS6fqrJOVY/whSn70SScHrcJ2LDsxWrneFoWYSVfqhQ== +"@typescript-eslint/typescript-estree@8.48.1": + version "8.48.1" + resolved "https://registry.yarnpkg.com/@typescript-eslint/typescript-estree/-/typescript-estree-8.48.1.tgz#0d0e31fc47c5796c6463ab50cde19e1718d465b1" + integrity sha512-/9wQ4PqaefTK6POVTjJaYS0bynCgzh6ClJHGSBj06XEHjkfylzB+A3qvyaXnErEZSaxhIo4YdyBgq6j4RysxDg== dependencies: - "@typescript-eslint/project-service" "8.38.0" - "@typescript-eslint/tsconfig-utils" "8.38.0" - "@typescript-eslint/types" "8.38.0" - "@typescript-eslint/visitor-keys" "8.38.0" + "@typescript-eslint/project-service" "8.48.1" + "@typescript-eslint/tsconfig-utils" "8.48.1" + "@typescript-eslint/types" "8.48.1" + "@typescript-eslint/visitor-keys" "8.48.1" debug "^4.3.4" - fast-glob "^3.3.2" - is-glob "^4.0.3" minimatch "^9.0.4" semver "^7.6.0" + tinyglobby "^0.2.15" ts-api-utils "^2.1.0" -"@typescript-eslint/utils@8.38.0": - version "8.38.0" - resolved "https://registry.yarnpkg.com/@typescript-eslint/utils/-/utils-8.38.0.tgz#5f10159899d30eb92ba70e642ca6f754bddbf15a" - integrity sha512-hHcMA86Hgt+ijJlrD8fX0j1j8w4C92zue/8LOPAFioIno+W0+L7KqE8QZKCcPGc/92Vs9x36w/4MPTJhqXdyvg== +"@typescript-eslint/utils@8.48.1": + version "8.48.1" + resolved "https://registry.yarnpkg.com/@typescript-eslint/utils/-/utils-8.48.1.tgz#6cf7b99e0943b33a983ef687b9a86b65578b5c32" + integrity sha512-fAnhLrDjiVfey5wwFRwrweyRlCmdz5ZxXz2G/4cLn0YDLjTapmN4gcCsTBR1N2rWnZSDeWpYtgLDsJt+FpmcwA== dependencies: "@eslint-community/eslint-utils" "^4.7.0" - "@typescript-eslint/scope-manager" "8.38.0" - "@typescript-eslint/types" "8.38.0" - "@typescript-eslint/typescript-estree" "8.38.0" + "@typescript-eslint/scope-manager" "8.48.1" + "@typescript-eslint/types" "8.48.1" + "@typescript-eslint/typescript-estree" "8.48.1" -"@typescript-eslint/visitor-keys@8.38.0": - version "8.38.0" - resolved "https://registry.yarnpkg.com/@typescript-eslint/visitor-keys/-/visitor-keys-8.38.0.tgz#a9765a527b082cb8fc60fd8a16e47c7ad5b60ea5" - integrity sha512-pWrTcoFNWuwHlA9CvlfSsGWs14JxfN1TH25zM5L7o0pRLhsoZkDnTsXfQRJBEWJoV5DL0jf+Z+sxiud+K0mq1g== +"@typescript-eslint/visitor-keys@8.48.1": + version "8.48.1" + resolved "https://registry.yarnpkg.com/@typescript-eslint/visitor-keys/-/visitor-keys-8.48.1.tgz#247d4fe6dcc044f45b7f1c15110bf95e5d73b334" + integrity sha512-BmxxndzEWhE4TIEEMBs8lP3MBWN3jFPs/p6gPm/wkv02o41hI6cq9AuSmGAaTTHPtA1FTi2jBre4A9rm5ZmX+Q== dependencies: - "@typescript-eslint/types" "8.38.0" + "@typescript-eslint/types" "8.48.1" eslint-visitor-keys "^4.2.1" acorn-jsx@^5.3.2: @@ -1888,10 +1885,15 @@ balanced-match@^1.0.0: resolved "https://registry.yarnpkg.com/balanced-match/-/balanced-match-1.0.2.tgz#e83e3a7e3f300b34cb9d87f615fa0cbf357690ee" integrity sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw== +baseline-browser-mapping@^2.8.25: + version "2.8.32" + resolved "https://registry.yarnpkg.com/baseline-browser-mapping/-/baseline-browser-mapping-2.8.32.tgz#5de72358cf363ac41e7d642af239f6ac5ed1270a" + integrity sha512-OPz5aBThlyLFgxyhdwf/s2+8ab3OvT7AdTNvKHBwpXomIYeXqpUUuT8LrdtxZSsWJ4R4CU1un4XGh5Ez3nlTpw== + bowser@^2.11.0: - version "2.11.0" - resolved "https://registry.yarnpkg.com/bowser/-/bowser-2.11.0.tgz#5ca3c35757a7aa5771500c70a73a9f91ef420a8f" - integrity sha512-AlcaJBi/pqqJBIQ8U9Mcpc9i8Aqxn88Skv5d+xBX006BY5u8N3mGLHa5Lgppa7L/HfwgwLgZ6NYs+Ag6uUmJRA== + version "2.13.1" + resolved "https://registry.yarnpkg.com/bowser/-/bowser-2.13.1.tgz#5a4c652de1d002f847dd011819f5fc729f308a7e" + integrity sha512-OHawaAbjwx6rqICCKgSG0SAnT05bzd7ppyKLVUITZpANBaaMFBAsaNkto3LoQ31tyFP5kNujE8Cdx85G9VzOkw== brace-expansion@^1.1.7: version "1.1.12" @@ -1908,22 +1910,16 @@ brace-expansion@^2.0.1: dependencies: balanced-match "^1.0.0" -braces@^3.0.3: - version "3.0.3" - resolved "https://registry.yarnpkg.com/braces/-/braces-3.0.3.tgz#490332f40919452272d55a8480adc0c441358789" - integrity sha512-yQbXgO/OSZVD2IsiLlro+7Hf6Q18EJrKSEsdoMzKePKXct3gvD8oLcOQdIzGupr5Fj+EDe8gO/lxc1BzfMpxvA== - dependencies: - fill-range "^7.1.1" - browserslist@^4.24.0: - version "4.25.1" - resolved "https://registry.yarnpkg.com/browserslist/-/browserslist-4.25.1.tgz#ba9e8e6f298a1d86f829c9b975e07948967bb111" - integrity sha512-KGj0KoOMXLpSNkkEI6Z6mShmQy0bc1I+T7K9N81k4WWMrfz+6fQ6es80B/YLAeRoKvjYE1YSHHOW1qe9xIVzHw== + version "4.28.0" + resolved "https://registry.yarnpkg.com/browserslist/-/browserslist-4.28.0.tgz#9cefece0a386a17a3cd3d22ebf67b9deca1b5929" + integrity sha512-tbydkR/CxfMwelN0vwdP/pLkDwyAASZ+VfWm4EOwlB6SWhx1sYnWLqo8N5j0rAzPfzfRaxt0mM/4wPU/Su84RQ== dependencies: - caniuse-lite "^1.0.30001726" - electron-to-chromium "^1.5.173" - node-releases "^2.0.19" - update-browserslist-db "^1.1.3" + baseline-browser-mapping "^2.8.25" + caniuse-lite "^1.0.30001754" + electron-to-chromium "^1.5.249" + node-releases "^2.0.27" + update-browserslist-db "^1.1.4" buffer-from@^1.0.0: version "1.1.2" @@ -1981,10 +1977,10 @@ camelcase@^5.0.0, camelcase@^5.3.1: resolved "https://registry.yarnpkg.com/camelcase/-/camelcase-5.3.1.tgz#e3c9b31569e106811df242f715725a1f4c494320" integrity sha512-L28STB170nwWS63UjtlEOE3dldQApaJXZkOI1uMFfzf3rRuPegHaHesyee+YxQ+W6SvRDQV6UrdOdRiR153wJg== -caniuse-lite@^1.0.30001726: - version "1.0.30001731" - resolved "https://registry.yarnpkg.com/caniuse-lite/-/caniuse-lite-1.0.30001731.tgz#277c07416ea4613ec564e5b0ffb47e7b60f32e2f" - integrity sha512-lDdp2/wrOmTRWuoB5DpfNkC0rJDU8DqRa6nYL6HK6sytw70QMopt/NIc/9SM7ylItlBWfACXk0tEn37UWM/+mg== +caniuse-lite@^1.0.30001754: + version "1.0.30001757" + resolved "https://registry.yarnpkg.com/caniuse-lite/-/caniuse-lite-1.0.30001757.tgz#a46ff91449c69522a462996c6aac4ef95d7ccc5e" + integrity sha512-r0nnL/I28Zi/yjk1el6ilj27tKcdjLsNqAOZr0yVjWPrSQyHgKI2INaEWw21bAQSv2LXRt1XuCS/GomNpWOxsQ== chalk@^1.0.0: version "1.1.3" @@ -2166,9 +2162,9 @@ debug@^3.2.7: ms "^2.1.1" debug@^4.1.0, debug@^4.1.1, debug@^4.3.1, debug@^4.3.2, debug@^4.3.4, debug@^4.4.1: - version "4.4.1" - resolved "https://registry.yarnpkg.com/debug/-/debug-4.4.1.tgz#e5a8bc6cbc4c6cd3e64308b0693a3d4fa550189b" - integrity sha512-KcKCqiftBJcZr++7ykoDIEwSa3XWowTfNPo92BYxjXiyYEVrUQh2aLyhxBCwww+heortUFxEJYcRzosstTEBYQ== + version "4.4.3" + resolved "https://registry.yarnpkg.com/debug/-/debug-4.4.3.tgz#c6ae432d9bd9662582fce08709b038c58e9e3d6a" + integrity sha512-RGwwWnwQvkVfavKVt22FGLw+xYSdzARwm0ru6DhTVA3umU5hZc28V3kO4stgYryrTlLpuvgI9GiijltAjNbcqA== dependencies: ms "^2.1.3" @@ -2238,10 +2234,10 @@ duplexer@^0.1.1: resolved "https://registry.yarnpkg.com/duplexer/-/duplexer-0.1.2.tgz#3abe43aef3835f8ae077d136ddce0f276b0400e6" integrity sha512-jtD6YG370ZCIi/9GTaJKQxWTZD045+4R4hTk/x1UyoqadyJ9x9CgSi1RlVDQF8U2sxLLSnFkCaMihqljHIWgMg== -electron-to-chromium@^1.5.173: - version "1.5.194" - resolved "https://registry.yarnpkg.com/electron-to-chromium/-/electron-to-chromium-1.5.194.tgz#05e541c3373ba8d967a65c92bc14d60608908236" - integrity sha512-SdnWJwSUot04UR51I2oPD8kuP2VI37/CADR1OHsFOUzZIvfWJBO6q11k5P/uKNyTT3cdOsnyjkrZ+DDShqYqJA== +electron-to-chromium@^1.5.249: + version "1.5.263" + resolved "https://registry.yarnpkg.com/electron-to-chromium/-/electron-to-chromium-1.5.263.tgz#bec8f2887c30001dfacf415c136eae3b4386846a" + integrity sha512-DrqJ11Knd+lo+dv+lltvfMDLU27g14LMdH2b0O3Pio4uk0x+z7OR+JrmyacTPN2M8w3BrZ7/RTwG3R9B7irPlg== emoji-regex@^7.0.1: version "7.0.3" @@ -2423,9 +2419,9 @@ eslint-plugin-import@^2.32.0: tsconfig-paths "^3.15.0" eslint-plugin-jsdoc@^52.0.2: - version "52.0.2" - resolved "https://registry.yarnpkg.com/eslint-plugin-jsdoc/-/eslint-plugin-jsdoc-52.0.2.tgz#90921df5bfd4a07c6cf4702d891f0e621d2bfffb" - integrity sha512-fYrnc7OpRifxxKjH78Y9/D/EouQDYD3G++bpR1Y+A+fy+CMzKZAdGIiHTIxCd2U10hb2y1NxN5TJt9aupq1vmw== + version "52.0.4" + resolved "https://registry.yarnpkg.com/eslint-plugin-jsdoc/-/eslint-plugin-jsdoc-52.0.4.tgz#d391b33dd8d6808d573118588451229d4f41f20d" + integrity sha512-be5OzGlLExvcK13Il3noU7/v7WmAQGenTmCaBKf1pwVtPOb6X+PGFVnJad0QhMj4KKf45XjE4hbsBxv25q1fTg== dependencies: "@es-joy/jsdoccomment" "~0.52.0" are-docs-informative "^0.0.2" @@ -2462,23 +2458,22 @@ eslint-visitor-keys@^4.2.1: integrity sha512-Uhdk5sfqcee/9H/rCOJikYz67o0a2Tw2hGRPOG2Y1R2dg7brRe1uG0yaNQDHu+TO/uQPF/5eCapvYSmHUjt7JQ== eslint@^9.32.0: - version "9.32.0" - resolved "https://registry.yarnpkg.com/eslint/-/eslint-9.32.0.tgz#4ea28df4a8dbc454e1251e0f3aed4bcf4ce50a47" - integrity sha512-LSehfdpgMeWcTZkWZVIJl+tkZ2nuSkyyB9C27MZqFWXuph7DvaowgcTvKqxvpLW1JZIk8PN7hFY3Rj9LQ7m7lg== + version "9.39.1" + resolved "https://registry.yarnpkg.com/eslint/-/eslint-9.39.1.tgz#be8bf7c6de77dcc4252b5a8dcb31c2efff74a6e5" + integrity sha512-BhHmn2yNOFA9H9JmmIVKJmd288g9hrVRDkdoIgRCRuSySRUHH7r/DI6aAXW9T1WwUuY3DFgrcaqB+deURBLR5g== dependencies: - "@eslint-community/eslint-utils" "^4.2.0" + "@eslint-community/eslint-utils" "^4.8.0" "@eslint-community/regexpp" "^4.12.1" - "@eslint/config-array" "^0.21.0" - "@eslint/config-helpers" "^0.3.0" - "@eslint/core" "^0.15.0" + "@eslint/config-array" "^0.21.1" + "@eslint/config-helpers" "^0.4.2" + "@eslint/core" "^0.17.0" "@eslint/eslintrc" "^3.3.1" - "@eslint/js" "9.32.0" - "@eslint/plugin-kit" "^0.3.4" + "@eslint/js" "9.39.1" + "@eslint/plugin-kit" "^0.4.1" "@humanfs/node" "^0.16.6" "@humanwhocodes/module-importer" "^1.0.1" "@humanwhocodes/retry" "^0.4.2" "@types/estree" "^1.0.6" - "@types/json-schema" "^7.0.15" ajv "^6.12.4" chalk "^4.0.0" cross-spawn "^7.0.6" @@ -2555,17 +2550,6 @@ fast-deep-equal@^3.1.1, fast-deep-equal@^3.1.3: resolved "https://registry.yarnpkg.com/fast-deep-equal/-/fast-deep-equal-3.1.3.tgz#3a7d56b559d6cbc3eb512325244e619a65c6c525" integrity sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q== -fast-glob@^3.3.2: - version "3.3.3" - resolved "https://registry.yarnpkg.com/fast-glob/-/fast-glob-3.3.3.tgz#d06d585ce8dba90a16b0505c543c3ccfb3aeb818" - integrity sha512-7MptL8U0cqcFdzIzwOTHoilX9x5BrNqye7Z/LuC7kCMRio1EMSyqRK3BEAUD7sXRq4iT4AzTVuZdhgQ2TCvYLg== - dependencies: - "@nodelib/fs.stat" "^2.0.2" - "@nodelib/fs.walk" "^1.2.3" - glob-parent "^5.1.2" - merge2 "^1.3.0" - micromatch "^4.0.8" - fast-json-patch@^3.1.1: version "3.1.1" resolved "https://registry.yarnpkg.com/fast-json-patch/-/fast-json-patch-3.1.1.tgz#85064ea1b1ebf97a3f7ad01e23f9337e72c66947" @@ -2588,12 +2572,10 @@ fast-xml-parser@5.2.5: dependencies: strnum "^2.1.0" -fastq@^1.6.0: - version "1.19.1" - resolved "https://registry.yarnpkg.com/fastq/-/fastq-1.19.1.tgz#d50eaba803c8846a883c16492821ebcd2cda55f5" - integrity sha512-GwLTyxkCXjXbxqIhTsMI2Nui8huMPtnxg7krajPJAjnEG/iiOS7i+zCtWGZR9G0NBKbXKh6X9m9UIsYX/N6vvQ== - dependencies: - reusify "^1.0.4" +fdir@^6.5.0: + version "6.5.0" + resolved "https://registry.yarnpkg.com/fdir/-/fdir-6.5.0.tgz#ed2ab967a331ade62f18d077dae192684d50d350" + integrity sha512-tIbYtZbucOs0BRGqPJkshJUYdL+SDH7dVM8gjy+ERp3WAUjLEFJE+02kanyHtwjWOnwrKYBiwAmM0p4kLJAnXg== figures@^1.4.0: version "1.7.0" @@ -2610,13 +2592,6 @@ file-entry-cache@^8.0.0: dependencies: flat-cache "^4.0.0" -fill-range@^7.1.1: - version "7.1.1" - resolved "https://registry.yarnpkg.com/fill-range/-/fill-range-7.1.1.tgz#44265d3cac07e3ea7dc247516380643754a05292" - integrity sha512-YsGpe3WHLK8ZYi4tWDg2Jy3ebRz2rXowDxnld4bkQB00cc/1Zw9AWnC0i9ztDJitivtQvaI9KaLyKrc+hBW0yg== - dependencies: - to-regex-range "^5.0.1" - find-cache-dir@^3.2.0: version "3.3.2" resolved "https://registry.yarnpkg.com/find-cache-dir/-/find-cache-dir-3.3.2.tgz#b30c5b6eff0730731aea9bbd9dbecbd80256d64b" @@ -2684,9 +2659,9 @@ fromentries@^1.2.0: integrity sha512-cHEpEQHUg0f8XdtZCc2ZAhrHzKzT0MrFUTcvx+hfxYu7rGMDc5SKoXFh+n4YigxsHXRzc6OrCshdR1bWH6HHyg== fs-extra@^11.3.0: - version "11.3.0" - resolved "https://registry.yarnpkg.com/fs-extra/-/fs-extra-11.3.0.tgz#0daced136bbaf65a555a326719af931adc7a314d" - integrity sha512-Z4XaCL6dUDHfP/jT25jJKMmtxvuwbkrD1vNSMFlo9lNLY2c5FHYSQgHPRZUjAB26TpDEoW9HCOgplrdbaPV/ew== + version "11.3.2" + resolved "https://registry.yarnpkg.com/fs-extra/-/fs-extra-11.3.2.tgz#c838aeddc6f4a8c74dd15f85e11fe5511bfe02a4" + integrity sha512-Xr9F6z6up6Ws+NjzMCZc6WXg2YFRlrLP9NQDO3VQrWrfiojdhS56TzueT88ze0uBdCTwEIhQ3ptnmKeWGFAe0A== dependencies: graceful-fs "^4.2.0" jsonfile "^6.0.1" @@ -2719,6 +2694,11 @@ functions-have-names@^1.2.3: resolved "https://registry.yarnpkg.com/functions-have-names/-/functions-have-names-1.2.3.tgz#0404fe4ee2ba2f607f0e0ec3c80bae994133b834" integrity sha512-xckBUXyTIqT97tq2x2AMb+g163b5JFysYk0x4qxNFwbfQkmNZoiRHb6sPzI9/QV33WeuvVYBUIiD4NzNIyqaRQ== +generator-function@^2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/generator-function/-/generator-function-2.0.1.tgz#0e75dd410d1243687a0ba2e951b94eedb8f737a2" + integrity sha512-SFdFmIJi+ybC0vjlHN0ZGVGHc3lgE0DxPAT0djjVg+kjOnSqclqmj0KQ7ykTOLP6YxoqOvuAODGdcHJn+43q3g== + gensync@^1.0.0-beta.2: version "1.0.0-beta.2" resolved "https://registry.yarnpkg.com/gensync/-/gensync-1.0.0-beta.2.tgz#32a6ee76c3d7f52d46b2b1ae5d93fea8580a25e0" @@ -2750,7 +2730,7 @@ get-package-type@^0.1.0: resolved "https://registry.yarnpkg.com/get-package-type/-/get-package-type-0.1.0.tgz#8de2d803cff44df3bc6c456e6668b36c3926e11a" integrity sha512-pjzuKtY64GYfWizNAJ0fr9VqttZkNiK2iS430LtIHzjBEr6bX8Am2zm4sW4Ro5wjWW5cAlRL1qAMTcXbjNAO2Q== -get-proto@^1.0.0, get-proto@^1.0.1: +get-proto@^1.0.1: version "1.0.1" resolved "https://registry.yarnpkg.com/get-proto/-/get-proto-1.0.1.tgz#150b3f2743869ef3e851ec0c49d15b1d14d00ee1" integrity sha512-sTSfBjoXBp89JvIKIefqw7U2CCebsc74kiY6awiGogKtoSGbgjYE/G/+l9sF3MWFPNc9IcoOC4ODfKHfxFmp0g== @@ -2772,13 +2752,6 @@ get-symbol-description@^1.1.0: es-errors "^1.3.0" get-intrinsic "^1.2.6" -glob-parent@^5.1.2: - version "5.1.2" - resolved "https://registry.yarnpkg.com/glob-parent/-/glob-parent-5.1.2.tgz#869832c58034fe68a4093c17dc15e8340d8401c4" - integrity sha512-AOIgSQCepiJYwP3ARnGx+5VnTu2HBYdzbGP45eLw1vr3zB3vZLeyed1sC9hnbcOc9/SrMyM5RPQrkGz4aS9Zow== - dependencies: - is-glob "^4.0.1" - glob-parent@^6.0.2: version "6.0.2" resolved "https://registry.yarnpkg.com/glob-parent/-/glob-parent-6.0.2.tgz#6d237d99083950c79290f24c7642a3de9a28f9e3" @@ -2804,9 +2777,9 @@ globals@^14.0.0: integrity sha512-oahGvuMGQlPw/ivIYBjVSrWAfWLBeku5tpPE2fOPLi+WHffIWbuh2tCjhyQhTBPMf5E9jDEH4FOmTYgYwbKwtQ== globals@^16.3.0: - version "16.3.0" - resolved "https://registry.yarnpkg.com/globals/-/globals-16.3.0.tgz#66118e765ddaf9e2d880f7e17658543f93f1f667" - integrity sha512-bqWEnJ1Nt3neqx2q5SFfGS8r/ahumIakg3HcwtNlrVlwXIeNumWn/c7Pn/wKzGhf6SaW6H6uWXLqC30STCMchQ== + version "16.5.0" + resolved "https://registry.yarnpkg.com/globals/-/globals-16.5.0.tgz#ccf1594a437b97653b2be13ed4d8f5c9f850cac1" + integrity sha512-c/c15i26VrJ4IRt5Z89DnIzCGDn9EcebibhAOjw5ibqEHsE1wLUgkPn9RDmNcUKyU87GeaL633nyJ+pplFR2ZQ== globalthis@^1.0.4: version "1.0.4" @@ -2918,9 +2891,9 @@ import-fresh@^3.2.1: resolve-from "^4.0.0" improved-yarn-audit@^3.0.3: - version "3.0.3" - resolved "https://registry.yarnpkg.com/improved-yarn-audit/-/improved-yarn-audit-3.0.3.tgz#c203ca2e6f3e0a60c62a0a261779a3d014585d5f" - integrity sha512-S9KWk8IF+oJOm1hl+uyAdNDlA6GV1PjeKP5ABjAYgLit78lNwfoF2LO39kw2aYr1WvhH2tJ1doTxj4Cikzv7Kw== + version "3.0.4" + resolved "https://registry.yarnpkg.com/improved-yarn-audit/-/improved-yarn-audit-3.0.4.tgz#5856ab354e21d98a12090ef690f6ff8b4c7bb8d3" + integrity sha512-secfgreRqLYmnp4qzaxxICpOC/RJxcfQSrDSVvkMTXS8bssjqMSuJiueqr07PVP87OlyfTytxDR2SkzIeoTfLQ== imurmurhash@^0.1.4: version "0.1.4" @@ -2979,13 +2952,13 @@ internal-slot@^1.1.0: side-channel "^1.1.0" inversify@^7.7.0: - version "7.7.0" - resolved "https://registry.yarnpkg.com/inversify/-/inversify-7.7.0.tgz#e25fab3547377a7cf966e80acb58c2ace2ff7e26" - integrity sha512-CLw7WbwULppLMNp6jPliwLbapnf996Bdju3VvtW0wrfI0LTuxv0h9uqrFh1RE3QO23+r4JK0hCarETJjDN4LFw== + version "7.10.4" + resolved "https://registry.yarnpkg.com/inversify/-/inversify-7.10.4.tgz#41b6595905fbaeaba3ae37416c699495dd6c110b" + integrity sha512-slBB4OeGHNR4yxAz/ChzFrFK9QKtZ+P+Ys0aYMv0nYc05eiB5hk1oqlHhgCZ13tiDj4806tF1LW3NQPcJjmipQ== dependencies: "@inversifyjs/common" "1.5.2" - "@inversifyjs/container" "1.12.1" - "@inversifyjs/core" "6.0.1" + "@inversifyjs/container" "1.14.1" + "@inversifyjs/core" "9.1.1" is-array-buffer@^3.0.4, is-array-buffer@^3.0.5: version "3.0.5" @@ -3034,7 +3007,7 @@ is-ci@^2.0.0: dependencies: ci-info "^2.0.0" -is-core-module@^2.13.0, is-core-module@^2.16.0, is-core-module@^2.16.1: +is-core-module@^2.13.0, is-core-module@^2.16.1: version "2.16.1" resolved "https://registry.yarnpkg.com/is-core-module/-/is-core-module-2.16.1.tgz#2a98801a849f43e2add644fbb6bc6229b19a4ef4" integrity sha512-UfoeMA6fIJ8wTYFEUjelnaGI67v6+N7qXJEvQuIGa99l4xsCruSYOVSQ0uPANn4dAzm8lkYPaKLrrijLq7x23w== @@ -3086,16 +3059,17 @@ is-fullwidth-code-point@^3.0.0: integrity sha512-zymm5+u+sCsSWyD9qNaejV3DFvhCKclKdizYaJUuHA83RLjb7nSuGnddCHGv0hk+KY7BMAlsWeK4Ueg6EV6XQg== is-generator-function@^1.0.10: - version "1.1.0" - resolved "https://registry.yarnpkg.com/is-generator-function/-/is-generator-function-1.1.0.tgz#bf3eeda931201394f57b5dba2800f91a238309ca" - integrity sha512-nPUB5km40q9e8UfN/Zc24eLlzdSf9OfKByBw9CIdw4H1giPMeA0OIJvbchsCu4npfI2QcMVBsGEBHKZ7wLTWmQ== + version "1.1.2" + resolved "https://registry.yarnpkg.com/is-generator-function/-/is-generator-function-1.1.2.tgz#ae3b61e3d5ea4e4839b90bad22b02335051a17d5" + integrity sha512-upqt1SkGkODW9tsGNG5mtXTXtECizwtS2kA161M+gJPc1xdb/Ax629af6YrTwcOeQHbewrPNlE5Dx7kzvXTizA== dependencies: - call-bound "^1.0.3" - get-proto "^1.0.0" + call-bound "^1.0.4" + generator-function "^2.0.0" + get-proto "^1.0.1" has-tostringtag "^1.0.2" safe-regex-test "^1.1.0" -is-glob@^4.0.0, is-glob@^4.0.1, is-glob@^4.0.3: +is-glob@^4.0.0, is-glob@^4.0.3: version "4.0.3" resolved "https://registry.yarnpkg.com/is-glob/-/is-glob-4.0.3.tgz#64f61e42cbbb2eec2071a9dac0b28ba1e65d5084" integrity sha512-xelSayHH36ZgE7ZWhli7pW34hNbNl8Ojv5KVmkJD4hBdD3th8Tfk9vYasLM+mXWOZhFkgZfxhLSnrwRr4elSSg== @@ -3120,11 +3094,6 @@ is-number-object@^1.1.1: call-bound "^1.0.3" has-tostringtag "^1.0.2" -is-number@^7.0.0: - version "7.0.0" - resolved "https://registry.yarnpkg.com/is-number/-/is-number-7.0.0.tgz#7535345b896734d5f80c4d06c50955527a14f12b" - integrity sha512-41Cifkg6e8TylSpdtTpeLVMqvSBEVzTttHvERD741+pnZ8ANv0004MRL43QKPDlK9cGvNp6NZWZUBlbGXYxxng== - is-regex@^1.2.1: version "1.2.1" resolved "https://registry.yarnpkg.com/is-regex/-/is-regex-1.2.1.tgz#76d70a3ed10ef9be48eb577887d74205bf0cad22" @@ -3275,9 +3244,9 @@ istanbul-lib-source-maps@^4.0.0: source-map "^0.6.1" istanbul-reports@^3.0.2: - version "3.1.7" - resolved "https://registry.yarnpkg.com/istanbul-reports/-/istanbul-reports-3.1.7.tgz#daed12b9e1dca518e15c056e1e537e741280fa0b" - integrity sha512-BewmUXImeuRk2YY0PVbxgKAysvhRPUQE0h5QRM++nVWyubKGV0l8qQ5op8+B2DOmwSe63Jivj0BjkPQVf8fP5g== + version "3.2.0" + resolved "https://registry.yarnpkg.com/istanbul-reports/-/istanbul-reports-3.2.0.tgz#cb4535162b5784aa623cee21a7252cf2c807ac93" + integrity sha512-HGYWWS/ehqTV3xN10i23tkPkpH46MLCIMFNCaaKNavAXTF1RkqxawEPtnjnGZ6XKSInBKkiOA5BKS+aZiY3AvA== dependencies: html-escaper "^2.0.0" istanbul-lib-report "^3.0.0" @@ -3288,17 +3257,17 @@ istanbul-reports@^3.0.2: integrity sha512-RdJUflcE3cUzKiMqQgsCu06FPu9UdIJO0beYbPhHN4k6apgJtifcoCtT9bcxOpYBtpD2kCM6Sbzg4CausW/PKQ== js-yaml@^3.12.0, js-yaml@^3.13.1: - version "3.14.1" - resolved "https://registry.yarnpkg.com/js-yaml/-/js-yaml-3.14.1.tgz#dae812fdb3825fa306609a8717383c50c36a0537" - integrity sha512-okMH7OXXJ7YrN9Ok3/SXrnu4iX9yOk+25nqX4imS2npuvTYDmo/QEZoqwZkYaIDk3jVvBOTOIEgEhaLOynBS9g== + version "3.14.2" + resolved "https://registry.yarnpkg.com/js-yaml/-/js-yaml-3.14.2.tgz#77485ce1dd7f33c061fd1b16ecea23b55fcb04b0" + integrity sha512-PMSmkqxr106Xa156c2M265Z+FTrPl+oxd/rgOQy2tijQeK5TxQ43psO1ZCwhVOSdnn+RzkzlRz/eY4BgJBYVpg== dependencies: argparse "^1.0.7" esprima "^4.0.0" -js-yaml@^4.1.0: - version "4.1.0" - resolved "https://registry.yarnpkg.com/js-yaml/-/js-yaml-4.1.0.tgz#c1fb65f8f5017901cdd2c951864ba18458a10602" - integrity sha512-wpxZs9NoxZaJESJGIZTyDEaYpl0FKSA+FB9aJiyemKhMwkxQg63h4T1KJgUGHpTqPDNRcmmYLugrRjJlBtWvRA== +js-yaml@^4.1.0, js-yaml@^4.1.1: + version "4.1.1" + resolved "https://registry.yarnpkg.com/js-yaml/-/js-yaml-4.1.1.tgz#854c292467705b699476e1a2decc0c8a3458806b" + integrity sha512-qQKT4zQxXl8lLwBtHMWwaTcGfFOZviOJet3Oy/xmGk2gZH677CJM9EvtfdSkgWcATZhj/55JZ0rmy3myCT5lsA== dependencies: argparse "^2.0.1" @@ -3340,9 +3309,9 @@ json5@^2.2.3: integrity sha512-XmOWe7eyHYH14cLdVPoyg+GOH3rYX++KpzrylJwSW98t3Nk+U8XOl8FWKOgwtzdb8lXGf6zYwDUzeHMWfxasyg== jsonfile@^6.0.1: - version "6.1.0" - resolved "https://registry.yarnpkg.com/jsonfile/-/jsonfile-6.1.0.tgz#bc55b2634793c679ec6403094eb13698a6ec0aae" - integrity sha512-5dgndWOriYSm5cnYaJNhalLNDKOqFwyDB/rr1E9ZsGciGvKPs8R2xYGCacuf3z6K1YKDz182fd+fY3cn3pMqXQ== + version "6.2.0" + resolved "https://registry.yarnpkg.com/jsonfile/-/jsonfile-6.2.0.tgz#7c265bd1b65de6977478300087c99f1c84383f62" + integrity sha512-FGuPw30AdOIUTRMC2OMRtQV+jkVj2cfPqSeWXv1NEAJ1qZ5zb1X6z1mFhbfOB/iy3ssJCD+3KuZ8r8C3uVFlAg== dependencies: universalify "^2.0.0" optionalDependencies: @@ -3514,19 +3483,6 @@ mdurl@^2.0.0: resolved "https://registry.yarnpkg.com/mdurl/-/mdurl-2.0.0.tgz#80676ec0433025dd3e17ee983d0fe8de5a2237e0" integrity sha512-Lf+9+2r+Tdp5wXDXC4PcIBjTDtq4UKjCPMQhKIuzpJNW0b96kVqSwW0bT7FhRSfmAiFYgP+SCRvdrDozfh0U5w== -merge2@^1.3.0: - version "1.4.1" - resolved "https://registry.yarnpkg.com/merge2/-/merge2-1.4.1.tgz#4368892f885e907455a6fd7dc55c0c9d404990ae" - integrity sha512-8q7VEgMJW4J8tcfVPy8g09NcQwZdbwFEqhe/WZkoIzjn/3TGDwtOCYtXGxA3O8tPzpczCCDgv+P2P5y00ZJOOg== - -micromatch@^4.0.8: - version "4.0.8" - resolved "https://registry.yarnpkg.com/micromatch/-/micromatch-4.0.8.tgz#d66fa18f3a47076789320b9b1af32bd86d9fa202" - integrity sha512-PXwfBhYu0hBCPw8Dn0E+WDYb7af3dSLVWKi3HGv84IdF4TyFoC0ysxFd0Goxw7nSv4T/PzEJQxsYsEiFCKo2BA== - dependencies: - braces "^3.0.3" - picomatch "^2.3.1" - mimic-fn@^1.0.0: version "1.2.0" resolved "https://registry.yarnpkg.com/mimic-fn/-/mimic-fn-1.2.0.tgz#820c86a39334640e99516928bd03fca88057d022" @@ -3592,10 +3548,10 @@ node-preload@^0.2.1: dependencies: process-on-spawn "^1.0.0" -node-releases@^2.0.19: - version "2.0.19" - resolved "https://registry.yarnpkg.com/node-releases/-/node-releases-2.0.19.tgz#9e445a52950951ec4d177d843af370b411caf314" - integrity sha512-xxOWJsBKtzAq7DY0J+DTzuz58K8e7sJbdgwkbMWQe8UYB6ekmsQ45q0M/tJDsGaZmbC+l7n57UV8Hl5tHxO9uw== +node-releases@^2.0.27: + version "2.0.27" + resolved "https://registry.yarnpkg.com/node-releases/-/node-releases-2.0.27.tgz#eedca519205cf20f650f61d56b070db111231e4e" + integrity sha512-nmh3lCkYZ3grZvqcCH+fjmQ7X+H0OeZgP40OierEaAptX4XofMh5kwNbWh7lBduUzCcV/8kZ+NDLCwm2iorIlA== nyc@^17.1.0: version "17.1.0" @@ -3834,10 +3790,10 @@ picocolors@^1.1.1: resolved "https://registry.yarnpkg.com/picocolors/-/picocolors-1.1.1.tgz#3d321af3eab939b083c8f929a1d12cda81c26b6b" integrity sha512-xceH2snhtb5M9liqDsmEw56le376mTZkEX/jEb/RxNFyegNul7eNslCXP9FDj/Lcu0X8KEyMceP2ntpaHrDEVA== -picomatch@^2.3.1: - version "2.3.1" - resolved "https://registry.yarnpkg.com/picomatch/-/picomatch-2.3.1.tgz#3ba3833733646d9d3e4995946c1365a67fb07a42" - integrity sha512-JU3teHTNjmE2VCGFzuY8EXzCDVwEqB2a8fsIvwaStHhAWJEeVd1o1QD80CU6+ZdEXXSLbSsuLwJjkCBWqRQUVA== +picomatch@^4.0.3: + version "4.0.3" + resolved "https://registry.yarnpkg.com/picomatch/-/picomatch-4.0.3.tgz#796c76136d1eead715db1e7bad785dedd695a042" + integrity sha512-5gTmgEY/sqK6gFXLIsQNH19lWb4ebPDLA4SdLP7dsWkIXHWlG66oPuVvXSGFPppYZz8ZDZq0dYYrbHfBCVUb1Q== pify@^3.0.0: version "3.0.0" @@ -3911,11 +3867,6 @@ punycode@^2.1.0: resolved "https://registry.yarnpkg.com/punycode/-/punycode-2.3.1.tgz#027422e2faec0b25e1549c3e1bd8309b9133b6e5" integrity sha512-vYt7UD1U9Wg6138shLtLOvdAu+8DsC/ilFtEVHcH+wydcSpNE20AfSOduf6MkRFahL5FY7X1oU7nKVZFtfq8Fg== -queue-microtask@^1.2.2: - version "1.2.3" - resolved "https://registry.yarnpkg.com/queue-microtask/-/queue-microtask-1.2.3.tgz#4929228bbc724dfac43e0efb058caf7b6cfb6243" - integrity sha512-NuaNSa6flKT5JaSYQzJok04JzTL1CA6aGhv5rfLW3PgqA+M2ChpZQnAC8h8i4ZFkBS8X5RqkDBHA7r4hej3K9A== - re-emitter@1.1.3: version "1.1.3" resolved "https://registry.yarnpkg.com/re-emitter/-/re-emitter-1.1.3.tgz#fa9e319ffdeeeb35b27296ef0f3d374dac2f52a7" @@ -4049,11 +4000,11 @@ resolve-from@^5.0.0: integrity sha512-qYg9KP24dD5qka9J47d0aVky0N+b4fTU89LN9iDnjB5waksiC49rvMB0PrUJQGoTmH50XPiqOvAjDfaijGxYZw== resolve@^1.22.4: - version "1.22.10" - resolved "https://registry.yarnpkg.com/resolve/-/resolve-1.22.10.tgz#b663e83ffb09bbf2386944736baae803029b8b39" - integrity sha512-NPRy+/ncIMeDlTAsuqwKIiferiawhefFJtkNSW0qZJEqMEb+qBt/77B/jGeeek+F0uOeN05CDa6HXbbIgtVX4w== + version "1.22.11" + resolved "https://registry.yarnpkg.com/resolve/-/resolve-1.22.11.tgz#aad857ce1ffb8bfa9b0b1ac29f1156383f68c262" + integrity sha512-RfqAvLnMl313r7c9oclB1HhUEAezcpLjz95wFH4LVuhk9JF/r22qmVP9AMmOU4vMX7Q8pN8jwNg/CSpdFnMjTQ== dependencies: - is-core-module "^2.16.0" + is-core-module "^2.16.1" path-parse "^1.0.7" supports-preserve-symlinks-flag "^1.0.0" @@ -4073,11 +4024,6 @@ restore-cursor@^3.1.0: onetime "^5.1.0" signal-exit "^3.0.2" -reusify@^1.0.4: - version "1.1.0" - resolved "https://registry.yarnpkg.com/reusify/-/reusify-1.1.0.tgz#0fe13b9522e1473f51b558ee796e08f11f9b489f" - integrity sha512-g6QUff04oZpHs0eG5p83rFLhHeV00ug/Yf9nZM6fLeUrPguBTkTQOdpAWWspMh55TZfVQDPaN3NQJfbVRAxdIw== - rimraf@^3.0.0: version "3.0.2" resolved "https://registry.yarnpkg.com/rimraf/-/rimraf-3.0.2.tgz#f1a5402ba6220ad52cc1282bac1ae3aa49fd061a" @@ -4092,13 +4038,6 @@ rimraf@~2.6.2: dependencies: glob "^7.1.3" -run-parallel@^1.1.9: - version "1.2.0" - resolved "https://registry.yarnpkg.com/run-parallel/-/run-parallel-1.2.0.tgz#66d1368da7bdf921eb9d95bd1a9229e7f21a43ee" - integrity sha512-5l4VyZR86LZ/lDxZTR6jqL8AFE2S0IFLMP26AbjsLVADxHdhB/c0GUsH+y39UfCi3dzz8OlQuPmnaJOMoDHQBA== - dependencies: - queue-microtask "^1.2.2" - safe-array-concat@^1.1.3: version "1.1.3" resolved "https://registry.yarnpkg.com/safe-array-concat/-/safe-array-concat-1.1.3.tgz#c9e54ec4f603b0bbb8e7e5007a5ee7aecd1538c3" @@ -4146,9 +4085,9 @@ scheduler@^0.18.0: object-assign "^4.1.1" semver@^6.0.0, semver@^6.3.1, semver@^7.5.2, semver@^7.5.3, semver@^7.5.4, semver@^7.6.0, semver@^7.7.2: - version "7.7.2" - resolved "https://registry.yarnpkg.com/semver/-/semver-7.7.2.tgz#67d99fdcd35cec21e6f8b87a7fd515a33f982b58" - integrity sha512-RF0Fw+rO5AMf9MAyaRXI4AV0Ulj5lMHqVxxdSgiVbixSCXoEmmX/jk0CuJw4+3SqroYO9VoUh+HcuJivvtJemA== + version "7.7.3" + resolved "https://registry.yarnpkg.com/semver/-/semver-7.7.3.tgz#4b5f4143d007633a8dc671cd0a6ef9147b8bb946" + integrity sha512-SdsKMrI9TdgjdweUSR9MweHA4EJ8YxHn8DFaDisvhVlUOe4BF1tLD7GAj0lIqWVl+dPb/rExr0Btby5loQm20Q== set-blocking@^2.0.0: version "2.0.0" @@ -4296,9 +4235,9 @@ spdx-expression-parse@^4.0.0: spdx-license-ids "^3.0.0" spdx-license-ids@^3.0.0: - version "3.0.21" - resolved "https://registry.yarnpkg.com/spdx-license-ids/-/spdx-license-ids-3.0.21.tgz#6d6e980c9df2b6fc905343a3b2d702a6239536c3" - integrity sha512-Bvg/8F5XephndSK3JffaRqdT+gyhfqIPwDHpX80tJrF8QQRYMo8sNMeaZ2Dp5+jhwKnUmIOyFFQfHRkjJm5nXg== + version "3.0.22" + resolved "https://registry.yarnpkg.com/spdx-license-ids/-/spdx-license-ids-3.0.22.tgz#abf5a08a6f5d7279559b669f47f0a43e8f3464ef" + integrity sha512-4PRT4nh1EImPbt2jASOKHX7PB7I+e4IWNLvkKFDxNhJlfjbYlleYQh285Z/3mPTHSAK/AvdMmw5BNNuYH8ShgQ== split@1.0.0: version "1.0.0" @@ -4559,17 +4498,18 @@ through@2: resolved "https://registry.yarnpkg.com/through/-/through-2.3.8.tgz#0dd4c9ffaabc357960b1b724115d7e0e86a2e1f5" integrity sha512-w89qg7PI8wAdvX60bMDP+bFoD5Dvhm9oLheFp5O4a2QF0cSBGsBX4qZmadPMvVqlLJBBci+WqGGOAPvcDeNSVg== -tmp@^0.2.1: - version "0.2.4" - resolved "https://registry.yarnpkg.com/tmp/-/tmp-0.2.4.tgz#c6db987a2ccc97f812f17137b36af2b6521b0d13" - integrity sha512-UdiSoX6ypifLmrfQ/XfiawN6hkjSBpCjhKxxZcWlUUmoXLaCKQU0bx4HF/tdDK2uzRuchf1txGvrWBzYREssoQ== - -to-regex-range@^5.0.1: - version "5.0.1" - resolved "https://registry.yarnpkg.com/to-regex-range/-/to-regex-range-5.0.1.tgz#1648c44aae7c8d988a326018ed72f5b4dd0392e4" - integrity sha512-65P7iz6X5yEr1cwcgvQxbbIw7Uk3gOy5dIdtZ4rDveLqhrdJP+Li/Hx6tyK0NEb+2GCyneCMJiGqrADCSNk8sQ== +tinyglobby@^0.2.15: + version "0.2.15" + resolved "https://registry.yarnpkg.com/tinyglobby/-/tinyglobby-0.2.15.tgz#e228dd1e638cea993d2fdb4fcd2d4602a79951c2" + integrity sha512-j2Zq4NyQYG5XMST4cbs02Ak8iJUdxRM0XI5QyxXuZOzKOINmWurp3smXu3y5wDcJrptwpSjgXHzIQxR0omXljQ== dependencies: - is-number "^7.0.0" + fdir "^6.5.0" + picomatch "^4.0.3" + +tmp@^0.2.1: + version "0.2.5" + resolved "https://registry.yarnpkg.com/tmp/-/tmp-0.2.5.tgz#b06bcd23f0f3c8357b426891726d16015abfd8f8" + integrity sha512-voyz6MApa1rQGUxT3E+BK7/ROe8itEx7vD8/HEvt4xwXucvQ5G5oeEiHkmHZJuBO21RpOf+YYm9MOivj709jow== trim@0.0.1, trim@^1.0.1: version "1.0.1" @@ -4677,20 +4617,20 @@ typedarray-to-buffer@^3.1.5: is-typedarray "^1.0.0" typedoc-plugin-missing-exports@^4.0.0: - version "4.0.0" - resolved "https://registry.yarnpkg.com/typedoc-plugin-missing-exports/-/typedoc-plugin-missing-exports-4.0.0.tgz#01916ce83173cb2e7b2942edfbe484f3bfbb0c8c" - integrity sha512-Z4ei+853xppDEhcqzyeyRs4+R0kUuKQWnMK1EtSTEd5LFkgkdW5Bdn8vfo/rsCGbYVJxOWU99fxgM1mROw5Fug== + version "4.1.2" + resolved "https://registry.yarnpkg.com/typedoc-plugin-missing-exports/-/typedoc-plugin-missing-exports-4.1.2.tgz#a125a679782082caad123e8b086b4ac9b28d08da" + integrity sha512-WNoeWX9+8X3E3riuYPduilUTFefl1K+Z+5bmYqNeH5qcWjtnTRMbRzGdEQ4XXn1WEO4WCIlU0vf46Ca2y/mspg== typedoc@^0.28.8: - version "0.28.8" - resolved "https://registry.yarnpkg.com/typedoc/-/typedoc-0.28.8.tgz#3f2de31e8b2233bab12fb40d25ff861a4fac0962" - integrity sha512-16GfLopc8icHfdvqZDqdGBoS2AieIRP2rpf9mU+MgN+gGLyEQvAO0QgOa6NJ5QNmQi0LFrDY9in4F2fUNKgJKA== + version "0.28.15" + resolved "https://registry.yarnpkg.com/typedoc/-/typedoc-0.28.15.tgz#667faf77eb934deb935fbfd5108a6de5f953948f" + integrity sha512-mw2/2vTL7MlT+BVo43lOsufkkd2CJO4zeOSuWQQsiXoV2VuEn7f6IZp2jsUDPmBMABpgR0R5jlcJ2OGEFYmkyg== dependencies: - "@gerrit0/mini-shiki" "^3.7.0" + "@gerrit0/mini-shiki" "^3.17.0" lunr "^2.3.9" markdown-it "^14.1.0" minimatch "^9.0.5" - yaml "^2.8.0" + yaml "^2.8.1" typescript@~5.8.2: version "5.8.3" @@ -4712,20 +4652,20 @@ unbox-primitive@^1.1.0: has-symbols "^1.1.0" which-boxed-primitive "^1.1.1" -undici-types@~7.8.0: - version "7.8.0" - resolved "https://registry.yarnpkg.com/undici-types/-/undici-types-7.8.0.tgz#de00b85b710c54122e44fbfd911f8d70174cd294" - integrity sha512-9UJ2xGDvQ43tYyVMpuHlsgApydB8ZKfVYTsLDhXkFL/6gfkp+U8xTGdh8pMJv1SpZna0zxG1DwsKZsreLbXBxw== +undici-types@~7.16.0: + version "7.16.0" + resolved "https://registry.yarnpkg.com/undici-types/-/undici-types-7.16.0.tgz#ffccdff36aea4884cbfce9a750a0580224f58a46" + integrity sha512-Zz+aZWSj8LE6zoxD+xrjh4VfkIG8Ya6LvYkZqtUQGJPZjYl53ypCaUwWqo7eI0x66KBGeRo+mlBEkMSeSZ38Nw== universalify@^2.0.0: version "2.0.1" resolved "https://registry.yarnpkg.com/universalify/-/universalify-2.0.1.tgz#168efc2180964e6386d061e094df61afe239b18d" integrity sha512-gptHNQghINnc/vTGIk0SOFGFNXw7JVrlRUtConJRlvaw6DuX0wO5Jeko9sWrMBhh+PsYAZ7oXAiOnf/UKogyiw== -update-browserslist-db@^1.1.3: - version "1.1.3" - resolved "https://registry.yarnpkg.com/update-browserslist-db/-/update-browserslist-db-1.1.3.tgz#348377dd245216f9e7060ff50b15a1b740b75420" - integrity sha512-UxhIZQ+QInVdunkDAaiazvvT/+fXL5Osr0JZlJulepYu6Jd7qJtDZjlur0emRlT71EN3ScPoE7gvsuIKKNavKw== +update-browserslist-db@^1.1.4: + version "1.1.4" + resolved "https://registry.yarnpkg.com/update-browserslist-db/-/update-browserslist-db-1.1.4.tgz#7802aa2ae91477f255b86e0e46dbc787a206ad4a" + integrity sha512-q0SPT4xyU84saUX+tomz1WLkxUbuaJnR1xWt17M7fJtEJigJeWUNGUqrauFXsHnqev9y9JTRGwk13tFBuKby4A== dependencies: escalade "^3.2.0" picocolors "^1.1.1" @@ -4747,11 +4687,6 @@ uuid@^8.3.2: resolved "https://registry.yarnpkg.com/uuid/-/uuid-8.3.2.tgz#80d5b5ced271bb9af6c445f21a1a04c606cefbe2" integrity sha512-+NYs2QeMWy+GWFOEm9xnn6HCDp0l7QBD7ml8zLUmJ+93Q5NF0NocErnwkTkXVFNiX3/fpC6afS8Dhb/gz7R7eg== -uuid@^9.0.1: - version "9.0.1" - resolved "https://registry.yarnpkg.com/uuid/-/uuid-9.0.1.tgz#e188d4c8853cc722220392c424cd637f32293f30" - integrity sha512-b+1eJOlsR9K8HJpow9Ok3fiWOWSIcIzXodvv0rQjVoOVNpWMpxf1wZNpt4y9h10odCNrqnYp1OBzRktckBe3sA== - which-boxed-primitive@^1.1.0, which-boxed-primitive@^1.1.1: version "1.1.1" resolved "https://registry.yarnpkg.com/which-boxed-primitive/-/which-boxed-primitive-1.1.1.tgz#d76ec27df7fa165f18d5808374a5fe23c29b176e" @@ -4892,10 +4827,10 @@ yaml@^1.10.2: resolved "https://registry.yarnpkg.com/yaml/-/yaml-1.10.2.tgz#2301c5ffbf12b467de8da2333a459e29e7920e4b" integrity sha512-r3vXyErRCYJ7wg28yvBY5VSoAF8ZvlcW9/BwUzEtUsjvX/DKs24dIkuwjtuprwJJHsbyUbLApepYTR1BN4uHrg== -yaml@^2.8.0: - version "2.8.0" - resolved "https://registry.yarnpkg.com/yaml/-/yaml-2.8.0.tgz#15f8c9866211bdc2d3781a0890e44d4fa1a5fff6" - integrity sha512-4lLa/EcQCB0cJkyts+FpIRx5G/llPxfP6VQU5KByHEhLxY3IJCH0f0Hy1MHI8sClTvsIb8qwRJ6R/ZdlDJ/leQ== +yaml@^2.8.0, yaml@^2.8.1: + version "2.8.2" + resolved "https://registry.yarnpkg.com/yaml/-/yaml-2.8.2.tgz#5694f25eca0ce9c3e7a9d9e00ce0ddabbd9e35c5" + integrity sha512-mplynKqc1C2hTVYxd0PU2xQAc22TI1vShAYGksCCfxbn/dFwnHTNi1bvYsBTkhdUNtGIf5xNOg938rrSSYvS9A== yargs-parser@^18.1.2: version "18.1.3"